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

Robbie Averill 53a99ac6ed Add request header strategies to allow extensibility 5 년 전
config 61163a7f07 Fix style 5 년 전
docs 53a99ac6ed Add request header strategies to allow extensibility 5 년 전
resources 53a99ac6ed Add request header strategies to allow extensibility 5 년 전
src 53a99ac6ed Add request header strategies to allow extensibility 5 년 전
tests 53a99ac6ed Add request header strategies to allow extensibility 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 811d3987e2 Update docs 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 년 전

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 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.