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

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

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.