Download the PHP package asxer/laravel-swagger without Composer
On this page you can find all versions of the php package asxer/laravel-swagger. 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-swagger
Laravel AutoDoc plugin
This plugin is designed to gather information and generate documentation about your Rest-Api while passing the tests. The principle of operation is based on the fact that the special Middleware installed on the Route for which you want to collect information that after the successful completion of all tests generated Swagger-file. In addition this plug-in is able to draw Swagger-template to display the generated documentation for a config.
Installation
Composer
composer require asxer/laravel-swagger
Laravel
- add
Asxer\Support\AutoDoc\AutoDocServiceProvider::class,to providers inconfig/app.php - run
php artisan vendor:publish
Plugin
- Add middleware \Asxer\Support\AutoDoc\Http\Middleware\AutoDocMiddleware::class to Http/Kernel.php.
- Use \Asxer\Support\AutoDoc\Tests\AutoDocTestCaseTrait in your TestCase in tests/TestCase.php
- In config/auto-doc.php you can specify enabling of plugin, info of your project, some defaults descriptions and route for rendering of documentation.
- In .env file you should add following lines
LOCAL_DATA_COLLECTOR_PROD_PATH=/example-folder/documentation.json LOCAL_DATA_COLLECTOR_TEMP_PATH=/tmp/documentation.json
Usages
For correct working of plugin you have to dispose all the validation rules in the rules() method of class YourRequest, which must be connected to the controller via DependencyInjection. In annotation of custom request you can specify summary and description of this request. Plugin will take validation rules from your request and use it as description of input parameter.
Example
- @summary - short description of request
- @description - Implementation Notes
-
@_204 - Custom description of code of response. You can specify any code as you want.
If you do not create a class Request, the summary, Implementation Notes and parameters will be empty. Plugin will collect codes and examples of responses only.
If you do not create annotations to request summary will generate automatically from Name of Request. For example request UpdateUserDataRequest will have summary Update user data request.
If you do not create annotations for descriptions of codes it will be generated automatically the following priorities:
- Annotations of request
- Default description from auto-doc.defaults.code-descriptions.{$code}
- Descriptions from Symfony\Component\HttpFoundation\Response::$statusTexts
Note about configs:
- auto-doc.route - it's a route where will be located generated documentation
- auto-doc.basePath - it's a route where located root of your api
Also you can specify way to collect documentation by creating your custom data collector class.
