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

Andrey Helldar 266bac6727 Fixed codestyle %!s(int64=5) %!d(string=hai) anos
config 4bf2ede494 Rename `reqyestHeaders` stage to `headers` for consistency and change order %!s(int64=5) %!d(string=hai) anos
docs 61c4ff19b1 Improve migration docs %!s(int64=5) %!d(string=hai) anos
resources e693d746b1 Add slashes to header values in bash templates to escape special chars (fix #643) %!s(int64=5) %!d(string=hai) anos
src 38932f0a62 Updated dockblocks and optimized qualified classes %!s(int64=5) %!d(string=hai) anos
tests 266bac6727 Fixed codestyle %!s(int64=5) %!d(string=hai) anos
.editorconfig 24d3f6aa22 Add some dotfiles %!s(int64=9) %!d(string=hai) anos
.gitattributes 6e60d14ea2 Make bodyParam parsing more rbust %!s(int64=6) %!d(string=hai) anos
.gitignore 2a99555f24 Implement non-static docs %!s(int64=5) %!d(string=hai) anos
.styleci.yml 4bafe50c2e Fucking StyleCI and the fucking Laravel style guide %!s(int64=5) %!d(string=hai) anos
.travis.yml e1c83d5699 Fixed `composer lint` command invocation in `.travis-ci.yml` %!s(int64=5) %!d(string=hai) anos
CHANGELOG.md 672c4f26c8 Update changelog %!s(int64=5) %!d(string=hai) anos
CONTRIBUTING.md 4c87b21d29 Update CONTRIBUTING.md %!s(int64=6) %!d(string=hai) anos
LICENSE.md 0e25996b83 Initial commit %!s(int64=9) %!d(string=hai) anos
README.md c5a771090c Prepare for release %!s(int64=5) %!d(string=hai) anos
body_params_1.png b7aad444e3 Update docs on urlParams %!s(int64=5) %!d(string=hai) anos
body_params_2.png b7aad444e3 Update docs on urlParams %!s(int64=5) %!d(string=hai) anos
composer.json e32b6ee3bf Added php-json extension into composer.json %!s(int64=5) %!d(string=hai) anos
phpstan.neon 46e7a65e32 Fixed error applying the parameter %!s(int64=5) %!d(string=hai) anos
phpunit.xml 8358c93058 Update test config to continue on failure %!s(int64=6) %!d(string=hai) anos

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.