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

shalvah 103b6894b7 Fix syntac highlighting in docs		vor 5 Jahren
config	9362af46d9 Add docs for responses	vor 5 Jahren
docs	103b6894b7 Fix syntac highlighting in docs	vor 5 Jahren
resources	e280e84cc1 Tweaks and improvements	vor 5 Jahren
routes	0d3df3ac45 Refactor Laravel type to use /docs for routing by default, rather than /doc.	vor 5 Jahren
src	f3ad433376 Fix tests	vor 5 Jahren
tests	f3ad433376 Fix tests	vor 5 Jahren
.editorconfig	24d3f6aa22 Add some dotfiles	vor 9 Jahren
.gitattributes	6e60d14ea2 Make bodyParam parsing more rbust	vor 6 Jahren
.gitignore	a81b4a86b9 Refactor tests	vor 5 Jahren
.styleci.yml	385fbc7ba0 Fix style	vor 5 Jahren
.travis.yml	9da8c80421 Fix lint	vor 5 Jahren
CHANGELOG.md	221018765b Fix tests	vor 5 Jahren
CONTRIBUTING.md	6457ea46f4 Add contribution guide	vor 5 Jahren
LICENSE.md	0e25996b83 Initial commit	vor 9 Jahren
README.md	908fd36b04 Update doc	vor 5 Jahren
composer.dingo.json	286c39bf16 Fix tests	vor 5 Jahren
composer.json	3e99d5b74f Update deps	vor 5 Jahren
logo-scribe.png	908fd36b04 Update doc	vor 5 Jahren
phpstan.neon	d854a593c1 Extend no overwrite feature to all standard markdown files, not just routes.	vor 5 Jahren
phpunit.xml	a81b4a86b9 Refactor tests	vor 5 Jahren
todo.md	9362af46d9 Add docs for responses	vor 5 Jahren

Scribe

Generate API documentation for humans from your Laravel codebase. Here's what the output looks like.

Installation

PHP 7.2.5 and Laravel/Lumen 5.8 or higher are required.

composer require --dev knuckleswtf/scribe

Publish the config file by running:

php artisan vendor:publish --provider="Knuckles\Scribe\ScribeServiceProvider" --tag=scribe-config

This will create a scribe.php file in your config folder.

When using Lumen, you will need to run composer require knuckleswtf/scribe instead.
Register the service provider in your bootstrap/app.php:

$app->register(\Knuckles\Scribe\ScribeServiceProvider::class);

Copy the config file from vendor/knuckleswtf/scribe/config/scribe.php to your project as config/scribe.php. Then add to your bootstrap/app.php:

$app->configure('scribe');

Check out the documentation at ReadTheDocs. Don't forget to check out the migration guide if you're coming from mpociot/laravel-apidoc-generator.

To learn how to contribute, see our contribution guide.