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

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

Marcel Pociot 876b3e7ab9 Apply fixes from StyleCI		преди 5 години
config	f27b3708fe Transformer annotations are now given priority over response annotation strategies	преди 5 години
docs	f27b3708fe Transformer annotations are now given priority over response annotation strategies	преди 5 години
resources	7306f69013 Use single quotes in PHP example template and mention how to customise them	преди 5 години
src	876b3e7ab9 Apply fixes from StyleCI	преди 5 години
tests	eef9a3e0c7 Apply fixes from StyleCI	преди 5 години
.editorconfig	24d3f6aa22 Add some dotfiles	преди 9 години
.gitattributes	6e60d14ea2 Make bodyParam parsing more rbust	преди 6 години
.gitignore	2a99555f24 Implement non-static docs	преди 5 години
.styleci.yml	4bafe50c2e Fucking StyleCI and the fucking Laravel style guide	преди 5 години
.travis.yml	d318033920 Update Travis config	преди 5 години
CHANGELOG.md	3c9267f44a Update changelog	преди 5 години
CONTRIBUTING.md	4c87b21d29 Update CONTRIBUTING.md	преди 6 години
LICENSE.md	0e25996b83 Initial commit	преди 9 години
README.md	811d3987e2 Update docs	преди 5 години
body_params_1.png	b7aad444e3 Update docs on urlParams	преди 5 години
body_params_2.png	b7aad444e3 Update docs on urlParams	преди 5 години
composer.json	8df5ec23c0 Use symfony/var-exporter to export PHP arrays, ensuring short array syntax	преди 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.2 and Laravel 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.

License

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

README.md