Download the PHP package chriha/laravel-api-documentation without Composer
On this page you can find all versions of the php package chriha/laravel-api-documentation. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-api-documentation
Automatically Provide A Swagger Documentation For Your Specs
This package helps providing a parsed Swagger documentation by using your OpenAPI YAML files.
Getting Started
Installation
`
Path to your specification
By default, the OpenAPI YAML specifications should be inside ./resources/api/.... In this directory, you can
create a file for each version, e.g. v1.yml, v2.yml, v3.yml and so on.
API version info
Each version (file) will provide an endpoint (e.g. v1.yml leads to /api/v1) with all the information, specified
under the info key:
... will result to the following response body:
Documentation
Will be available via the URI /docs/api/[VERSION] and the file at /docs/api/[VERSION]/file.
Configuration
If you would like to change the default configuration, you can publish and update it to your needs:
Configuration will then be available in ./config/api-documentation.php.
Specifications path and naming format
You can change the path to your specifications and the format of your files via the specifications key in the
configuration.
Changing the middleware
By default, the documentation uses the web-, the API info endpoint the api-middleware. You can change this in the
configuration by changing the middleware key.
Hiding information
If you want to hide keys from the info endpoint (e.g. /api/v1), you can specify those in the configuration
under specifications.hide via "dot" notation.
Development
Conventional Commits
Please use conventional commits for automated semantic versioning, if you submit your merge request.
Dry Run Semantic Release
Contributing
Please read CONTRIBUTING.md for details on the code of conduct, and the process for submitting pull requests.
All versions of laravel-api-documentation with dependencies
symfony/yaml Version ^6.0|^7.0
illuminate/http Version ^9.0|^10.0|^11.0
illuminate/support Version ^9.0|^10.0|^11.0
illuminate/routing Version ^9.0|^10.0|^11.0
illuminate/view Version ^9.0|^10.0|^11.0