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

shalvah d5cb0c4354 Exclude Dingo composer lockfile from Git před 5 roky
config 2af2f016e1 Merge pull request #659 from andrey-helldar/patch-2019-12-17-11-42 před 5 roky
docs 7363bb407c Fix typo in the spelling of "running" před 5 roky
resources b0ddb97644 Update tests před 5 roky
routes 17270c7ff5 Fix route address error for JSON před 5 roky
src 81603e9c55 Fixes laravel route to postman collection před 5 roky
tests 4ec17dc938 Fix tests for Dingo před 5 roky
.editorconfig 24d3f6aa22 Add some dotfiles před 9 roky
.gitattributes 6e60d14ea2 Make bodyParam parsing more rbust před 6 roky
.gitignore d5cb0c4354 Exclude Dingo composer lockfile from Git před 5 roky
.styleci.yml 385fbc7ba0 Fix style před 5 roky
.travis.yml 45ce1f2432 Rearrange jobs před 5 roky
CHANGELOG.md b13004f681 Update CHANGELOG.md před 5 roky
CONTRIBUTING.md 4c87b21d29 Update CONTRIBUTING.md před 6 roky
LICENSE.md 0e25996b83 Initial commit před 9 roky
README.md 0f1132760e Add example link před 5 roky
body_params_1.png b7aad444e3 Update docs on urlParams před 5 roky
body_params_2.png b7aad444e3 Update docs on urlParams před 5 roky
composer.json ceb6a57313 Remove unused dependencies před 5 roky
dingo.composer.json 1c55c7c91d Fix version incompatibilities for Dingo před 5 roky
phpstan.neon 28b89de019 Ignore errors relating to Dingo when linting před 5 roky
phpunit.xml 8358c93058 Update test config to continue on failure před 6 roky

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.