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

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

Shalvah 083281d95c Merge pull request #581 from mpociot/plugin-fixes-improvements		пре 5 година
config	ffb3563bfd Update docs, refactor API	пре 5 година
docs	e94dc4ed92 Use default strategies for each stage if not specified	пре 5 година
resources	ec1c4e90ac Fix Class 'Arr' not found	пре 5 година
src	0901dc01d8 Apply fixes from StyleCI	пре 5 година
tests	18938eb407 Set status code for transformer response from tag if present	пре 5 година
.editorconfig	24d3f6aa22 Add some dotfiles	пре 9 година
.gitattributes	6e60d14ea2 Make bodyParam parsing more rbust	пре 6 година
.gitignore	270264268f Exclude Laravel Telescope routes by default	пре 5 година
.styleci.yml	4bafe50c2e Fucking StyleCI and the fucking Laravel style guide	пре 5 година
.travis.yml	3dc0c30b5d Tweak Travis config	пре 5 година
CHANGELOG.md	248a05245a Update CHANGELOG.md	пре 5 година
CONTRIBUTING.md	4c87b21d29 Update CONTRIBUTING.md	пре 6 година
LICENSE.md	0e25996b83 Initial commit	пре 9 година
README.md	45310bf9a3 Only require the package for dev environments by default.	пре 6 година
TODO.md	5647eda35e Parse @group tag on method properly - fixes #564, #561	пре 5 година
body_params.png	b8ad92b9e5 Add authenticated annotation and badge support (closes #345)	пре 6 година
composer.json	270264268f Exclude Laravel Telescope routes by default	пре 5 година
phpstan.neon	bca5c062d1 #543 Add exception for forceScheme to appease phpstan	пре 5 година
phpunit.xml	8358c93058 Update test config to continue on failure	пре 6 година

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 and Laravel 5.5 or higher are required.

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.

License

The Laravel API Documentation Generator is free software licensed under the MIT license.

README.md