Scribe可以帮助您自动生成文档，但是如果您真的想制作友好，可维护和可测试的API文档，则还需要了解更多信息。所以我为你做了一门课程。🤗
Andrey Helldar
266bac6727
Fixed codestyle
|
5 years ago | |
|---|---|---|
| config | 5 years ago | |
| docs | 5 years ago | |
| resources | 5 years ago | |
| src | 5 years ago | |
| tests | 5 years ago | |
| .editorconfig | 9 years ago | |
| .gitattributes | 6 years ago | |
| .gitignore | 5 years ago | |
| .styleci.yml | 5 years ago | |
| .travis.yml | 5 years ago | |
| CHANGELOG.md | 5 years ago | |
| CONTRIBUTING.md | 6 years ago | |
| LICENSE.md | 9 years ago | |
| README.md | 5 years ago | |
| body_params_1.png | 5 years ago | |
| body_params_2.png | 5 years ago | |
| composer.json | 5 years ago | |
| phpstan.neon | 5 years ago | |
| phpunit.xml | 6 years ago |
README.md
Laravel API Documentation Generator
Automatically generate your API documentation from your existing Laravel/Lumen/Dingo routes. Here's what the output looks like.
php artisan apidoc:generate
Installation
PHP 7.2 and Laravel/Lumen 5.7 or higher are required.
If your application does not meet these requirements, you can check out the 3.x branch for older releases.
composer require --dev mpociot/laravel-apidoc-generator
Laravel
Publish the config file by running:
php artisan vendor:publish --provider="Mpociot\ApiDoc\ApiDocGeneratorServiceProvider" --tag=apidoc-config
This will create an apidoc.php file in your config folder.
Lumen
- When using Lumen, you will need to run
composer require mpociot/laravel-apidoc-generatorinstead. - Register the service provider in your
bootstrap/app.php:
$app->register(\Mpociot\ApiDoc\ApiDocGeneratorServiceProvider::class);
- Copy the config file from
vendor/mpociot/laravel-apidoc-generator/config/apidoc.phpto your project asconfig/apidoc.php. Then add to yourbootstrap/app.php:
$app->configure('apidoc');
Documentation
Check out the documentation at ReadTheDocs. Don't forget to check out the migration guide if you're coming from v3 to v4.
License
The Laravel API Documentation Generator is free software licensed under the MIT license.