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

Guilherme Pressutto b3a93deda0 Not using config helper inside config file 5 éve
config b3a93deda0 Not using config helper inside config file 5 éve
docs 2f8ee8fec5 makes the suggested changes 5 éve
resources 6bc4b53f8c Add support for query parameters in the bash template and ensure that all query parameters are URL-encoded. 5 éve
src b3a93deda0 Not using config helper inside config file 5 éve
tests 6bc4b53f8c Add support for query parameters in the bash template and ensure that all query parameters are URL-encoded. 5 éve
.editorconfig 24d3f6aa22 Add some dotfiles 9 éve
.gitattributes 6e60d14ea2 Make bodyParam parsing more rbust 6 éve
.gitignore 8ebae10774 Add Sphinx doc 6 éve
.styleci.yml f0dc118c6b Fix StyleCI 7.0 error; fix route url bindings 6 éve
.travis.yml 428c0f27ce Fix Travis build config 6 éve
CHANGELOG.md 19d5656413 Update CHANGELOG.md 5 éve
CONTRIBUTING.md 4c87b21d29 Update CONTRIBUTING.md 6 éve
LICENSE.md 0e25996b83 Initial commit 9 éve
README.md 45310bf9a3 Only require the package for dev environments by default. 5 éve
TODO.md 5d2be82a57 Replace file/folder manipulation with Flysystem library 5 éve
body_params.png b8ad92b9e5 Add authenticated annotation and badge support (closes #345) 6 éve
composer.json 2f3a2144e1 Fix build - remove collision package by default 5 éve
phpunit.xml 8358c93058 Update test config to continue on failure 6 éve

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