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

shalvah 52d9234330 Update customer memory limit		vor 4 Jahren
.github	e1c790e1e1 Update troubleshooting info	vor 4 Jahren
config	9c46db3e2b Update docs	vor 4 Jahren
docs	9c46db3e2b Update docs	vor 4 Jahren
resources	6f229f71d4 Support nested array/object types better when generating examples and normalising	vor 4 Jahren
routes	1e15d01910 Added OpenAPI spec generation support	vor 4 Jahren
src	a516c25ca7 Attempt to speed up tests	vor 4 Jahren
tests	22d960facf Try to make tests faster	vor 4 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	52d9234330 Update customer memory limit	vor 4 Jahren
CHANGELOG.0-1.md	627ba652e9 Update changelog	vor 5 Jahren
CHANGELOG.md	4d3648f0b8 Update changelog	vor 4 Jahren
CONTRIBUTING.md	6457ea46f4 Add contribution guide	vor 5 Jahren
LICENSE.md	437504e237 Update license	vor 4 Jahren
README.md	0d63f72c3e Update README.md	vor 4 Jahren
composer.dingo.json	afd15ecc42 Update test settings	vor 4 Jahren
composer.json	770ceb6bd3 Update deps	vor 4 Jahren
logo-scribe.png	908fd36b04 Update doc	vor 5 Jahren
phpstan.neon	86ce875d44 Fix lint	vor 4 Jahren
phpunit.xml	afd15ecc42 Update test settings	vor 4 Jahren
todo.md	6b32e2880f Add file upload support to Python example requests	vor 5 Jahren

Scribe

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

Looking to document your Node.js APIs? Check out Scribe for JS.

Features

Pretty HTML documentation page, with included code samples and friendly text
Markdown source files that can be edited to modify docs
Extracts body parameters information from Laravel FormRequests
Safely calls API endpoints to generate sample responses, with authentication and other custom configuration supported
Supports generating responses from Eloquent API Resources or Fractal Transformers
Supports Postman collection and OpenAPI (Swagger) spec generation
Included UI components for additional styling
Easily customisable with custom views
Easily extensible with custom strategies

Scribe is a fork of mpociot/laravel-apidoc-generator, so see the migration guide if you're coming from there.

Check out the documentation at ReadTheDocs.

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 (no --dev.
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');

Contributing is easy! See our contribution guide.