This package helps providing a parsed Swagger documentation by using your OpenAPI YAML files.
composer require chriha/laravel-api-documentationBy 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.
Each version (file) will provide an endpoint (e.g. v1.yml leads to /api/v1) with all the information, specified
under the info key:
...
info:
version: "v1.0.1"
title: "Awesome API"
contact:
email: "[email protected]"
...... will result to the following response body:
{
"version": "v1.0.1",
"title": "Awesome API",
"contact": {
"email": "[email protected]"
}
}Will be available via the URI /docs/api/[VERSION] and the file at /docs/api/[VERSION]/file.
If you would like to change the default configuration, you can publish and update it to your needs:
php artisan vendor:publish --provider="Chriha\ApiDocumentation\ApiDocumentationServiceProvider"Configuration will then be available in ./config/api-documentation.php.
You can change the path to your specifications and the format of your files via the specifications key in the
configuration.
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.
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.
'specifications' => [
'hide' => [
'v1' => [
'contact.email',
'description',
]
],
],Please use conventional commits for automated semantic versioning, if you submit your merge request.
npm i @semantic-release/changelog @semantic-release/git @semantic-release/exec -D
GITHUB_TOKEN=YOUR_GITHUB_TOKEN npx semantic-release --dry-run --no-ciPlease read CONTRIBUTING.md for details on the code of conduct, and the process for submitting pull requests.