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

shalvah 98c039ab59 Move Postman collection link to sidebar + make links work on laravel and static 5 gadi atpakaļ
config 6cc5127bce Switch to pastel 5 gadi atpakaļ
docs 54cd39d7f0 Switch to pastel 5 gadi atpakaļ
resources 98c039ab59 Move Postman collection link to sidebar + make links work on laravel and static 5 gadi atpakaļ
routes 17270c7ff5 Fix route address error for JSON 5 gadi atpakaļ
src 98c039ab59 Move Postman collection link to sidebar + make links work on laravel and static 5 gadi atpakaļ
tests 54cd39d7f0 Switch to pastel 5 gadi atpakaļ
.editorconfig 24d3f6aa22 Add some dotfiles 9 gadi atpakaļ
.gitattributes 6e60d14ea2 Make bodyParam parsing more rbust 6 gadi atpakaļ
.gitignore d5cb0c4354 Exclude Dingo composer lockfile from Git 5 gadi atpakaļ
.styleci.yml 385fbc7ba0 Fix style 5 gadi atpakaļ
.travis.yml d6100fcf5f Switch to clara for logging 5 gadi atpakaļ
CHANGELOG.md 54cd39d7f0 Switch to pastel 5 gadi atpakaļ
CONTRIBUTING.md 4c87b21d29 Update CONTRIBUTING.md 6 gadi atpakaļ
LICENSE.md 0e25996b83 Initial commit 9 gadi atpakaļ
README.md 0f1132760e Add example link 5 gadi atpakaļ
body_params_1.png b7aad444e3 Update docs on urlParams 5 gadi atpakaļ
body_params_2.png b7aad444e3 Update docs on urlParams 5 gadi atpakaļ
composer.dingo.json d6100fcf5f Switch to clara for logging 5 gadi atpakaļ
composer.json d6100fcf5f Switch to clara for logging 5 gadi atpakaļ
phpstan.neon 28b89de019 Ignore errors relating to Dingo when linting 5 gadi atpakaļ
phpunit.xml 54cd39d7f0 Switch to pastel 5 gadi atpakaļ

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.