Scribe可以帮助您自动生成文档,但是如果您真的想制作友好,可维护和可测试的API文档,则还需要了解更多信息。所以我为你做了一门课程。🤗

Guy Marriott 890a920ebd Move DI to handle method from constructor 5 rokov pred
config 6770e678d0 Expanding Postman collection support 5 rokov pred
docs ca5b9d095e Added routeMatcher config option to docs 5 rokov pred
resources e693d746b1 Add slashes to header values in bash templates to escape special chars (fix #643) 5 rokov pred
src 890a920ebd Move DI to handle method from constructor 5 rokov pred
tests 6416762cae Remove functionality that converts URL paramters to query parameters 5 rokov pred
.editorconfig 24d3f6aa22 Add some dotfiles 9 rokov pred
.gitattributes 6e60d14ea2 Make bodyParam parsing more rbust 6 rokov pred
.gitignore 2a99555f24 Implement non-static docs 5 rokov pred
.styleci.yml 4bafe50c2e Fucking StyleCI and the fucking Laravel style guide 5 rokov pred
.travis.yml d318033920 Update Travis config 5 rokov pred
CHANGELOG.md 970c5b374d Update CHANGELOG.md 5 rokov pred
CONTRIBUTING.md 4c87b21d29 Update CONTRIBUTING.md 6 rokov pred
LICENSE.md 0e25996b83 Initial commit 9 rokov pred
README.md c5a771090c Prepare for release 5 rokov pred
body_params_1.png b7aad444e3 Update docs on urlParams 5 rokov pred
body_params_2.png b7aad444e3 Update docs on urlParams 5 rokov pred
composer.json 8df5ec23c0 Use symfony/var-exporter to export PHP arrays, ensuring short array syntax 5 rokov pred
phpstan.neon 7a0aa89c65 Updating PHPStan exceptions 5 rokov pred
phpunit.xml 8358c93058 Update test config to continue on failure 6 rokov pred

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

Latest Stable VersionTotal Downloads License codecov.io Scrutinizer Code Quality Build Status StyleCI

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-generator instead.
  • 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.php to your project as config/apidoc.php. Then add to your bootstrap/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.