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

176 Rilis

Shalvah 67d5605e98 Added tip on web routes		5 tahun lalu
.github	78aca42f1a Update pull_request_template.md	5 tahun lalu
config	42d034f626 Update scribe.php	5 tahun lalu
docs	67d5605e98 Added tip on web routes	5 tahun lalu
resources	d442641b4b Fix bug with fetching pagination type for API Resources	5 tahun lalu
routes	0d3df3ac45 Refactor Laravel type to use /docs for routing by default, rather than /doc.	5 tahun lalu
src	d10675ac27 Update Writer.php	5 tahun lalu
tests	ac8564f1e7 feat(config): ability to set postman base_url independently	5 tahun lalu
.editorconfig	24d3f6aa22 Add some dotfiles	9 tahun lalu
.gitattributes	6e60d14ea2 Make bodyParam parsing more rbust	6 tahun lalu
.gitignore	a81b4a86b9 Refactor tests	5 tahun lalu
.styleci.yml	385fbc7ba0 Fix style	5 tahun lalu
.travis.yml	9da8c80421 Fix lint	5 tahun lalu
CHANGELOG.0-1.md	627ba652e9 Update changelog	5 tahun lalu
CHANGELOG.md	fedd45afaa Update CHANGELOG.md	5 tahun lalu
CONTRIBUTING.md	6457ea46f4 Add contribution guide	5 tahun lalu
LICENSE.md	0e25996b83 Initial commit	9 tahun lalu
README.md	81b565549a Migrate to travis-ci.com	5 tahun lalu
composer.dingo.json	6721694c27 Update deps	5 tahun lalu
composer.json	6721694c27 Update deps	5 tahun lalu
logo-scribe.png	908fd36b04 Update doc	5 tahun lalu
phpstan.neon	d854a593c1 Extend no overwrite feature to all standard markdown files, not just routes.	5 tahun lalu
phpunit.xml	a81b4a86b9 Refactor tests	5 tahun lalu
todo.md	6b32e2880f Add file upload support to Python example requests	5 tahun lalu

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.