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

shalvah d2901e51a6 Re-add faker seed + tests il y a 6 ans
config d2901e51a6 Re-add faker seed + tests il y a 6 ans
docs b9646362d7 Update docs to reflect support for route URLs in include/exclude il y a 6 ans
resources 793f15ace8 Fix tests il y a 6 ans
src 09b22769b7 Merge pull request #507 from lucianobargmann/patch-1 il y a 6 ans
tests d2901e51a6 Re-add faker seed + tests il y a 6 ans
.editorconfig 24d3f6aa22 Add some dotfiles il y a 9 ans
.gitattributes 6e60d14ea2 Make bodyParam parsing more rbust il y a 6 ans
.gitignore 8ebae10774 Add Sphinx doc il y a 6 ans
.styleci.yml f0dc118c6b Fix StyleCI 7.0 error; fix route url bindings il y a 6 ans
.travis.yml 428c0f27ce Fix Travis build config il y a 6 ans
CHANGELOG.md 58908932d1 Update changelog il y a 6 ans
CONTRIBUTING.md 4c87b21d29 Update CONTRIBUTING.md il y a 6 ans
LICENSE.md 0e25996b83 Initial commit il y a 9 ans
README.md c1c2349060 Update README.md il y a 6 ans
TODO.md d2901e51a6 Re-add faker seed + tests il y a 6 ans
body_params.png b8ad92b9e5 Add authenticated annotation and badge support (closes #345) il y a 6 ans
composer.json cccfa3b20e Add support for Laravel 5.8 il y a 6 ans
phpunit.xml 8358c93058 Update test config to continue on failure il y a 6 ans

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

composer require 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

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