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

shalvah 0c221d8b07 Tweak Travis config vor 5 Jahren
config b3a93deda0 Not using config helper inside config file vor 5 Jahren
docs e1a43b0143 PHPStan linting vor 5 Jahren
resources abb7ef5b60 Separate endpoint group anem frmo group description and key by group name. Fixes #535 vor 5 Jahren
src 4bafe50c2e Fucking StyleCI and the fucking Laravel style guide vor 5 Jahren
tests 69121bb200 Apply fixes from StyleCI vor 5 Jahren
.editorconfig 24d3f6aa22 Add some dotfiles vor 9 Jahren
.gitattributes 6e60d14ea2 Make bodyParam parsing more rbust vor 6 Jahren
.gitignore 8ebae10774 Add Sphinx doc vor 6 Jahren
.styleci.yml 4bafe50c2e Fucking StyleCI and the fucking Laravel style guide vor 5 Jahren
.travis.yml 0c221d8b07 Tweak Travis config vor 5 Jahren
CHANGELOG.md 16cfc4f4da Update changelog vor 5 Jahren
CONTRIBUTING.md 4c87b21d29 Update CONTRIBUTING.md vor 6 Jahren
LICENSE.md 0e25996b83 Initial commit vor 9 Jahren
README.md 45310bf9a3 Only require the package for dev environments by default. vor 5 Jahren
TODO.md 5d2be82a57 Replace file/folder manipulation with Flysystem library vor 5 Jahren
body_params.png b8ad92b9e5 Add authenticated annotation and badge support (closes #345) vor 6 Jahren
composer.json 6951db5006 Tweak Travis config vor 5 Jahren
phpstan.neon d5eef26cc5 Fix PHPStan config vor 5 Jahren
phpunit.xml 8358c93058 Update test config to continue on failure vor 6 Jahren

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.