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

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

shalvah 09aeebd712 Use database transactions and `create()` when instantiating factory models		5 anni fa
config	6a0bdbab84 Add ability to customise intro text	5 anni fa
docs	688020662c Add support for states, relations, and pagination in API Resources and Transformer	5 anni fa
resources	6a0bdbab84 Add ability to customise intro text	5 anni fa
routes	277f3d1080 Rename project to Scribe	5 anni fa
src	09aeebd712 Use database transactions and `create()` when instantiating factory models	5 anni fa
tests	688020662c Add support for states, relations, and pagination in API Resources and Transformer	5 anni fa
.editorconfig	24d3f6aa22 Add some dotfiles	9 anni fa
.gitattributes	6e60d14ea2 Make bodyParam parsing more rbust	6 anni fa
.gitignore	277f3d1080 Rename project to Scribe	5 anni fa
.styleci.yml	385fbc7ba0 Fix style	5 anni fa
.travis.yml	d6100fcf5f Switch to clara for logging	5 anni fa
CHANGELOG.md	221018765b Fix tests	5 anni fa
CONTRIBUTING.md	4c87b21d29 Update CONTRIBUTING.md	6 anni fa
LICENSE.md	0e25996b83 Initial commit	9 anni fa
README.md	863259386b Allow indication of binary responses (fix mpociot/laravel-apidoc-generator#479)	5 anni fa
body_params_1.png	b7aad444e3 Update docs on urlParams	5 anni fa
body_params_2.png	b7aad444e3 Update docs on urlParams	5 anni fa
composer.dingo.json	0c8afe8d54 Parallel testing with paratest	5 anni fa
composer.json	0c8afe8d54 Parallel testing with paratest	5 anni fa
phpstan.neon	28b89de019 Ignore errors relating to Dingo when linting	5 anni fa
phpunit.xml	b804f02e7c Add support for multiple scenario descriptions in @response tag	5 anni fa

Scribe ✍

Automatically generate your API documentation from your existing Laravel/Lumen/Dingo routes. Here's what the output looks like.

Installation

PHP 7.2 and Laravel/Lumen 5.7 or higher are required.

If your application does not meet these requirements, you can check out the 3.x branch for older releases.

composer require --dev knuckleswtf/scribe

Laravel

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.

Lumen

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');

Documentation

Check out the documentation at ReadTheDocs. Don't forget to check out the migration guide if you're coming from v3 to v4.

License

The Laravel API Documentation Generator is free software licensed under the MIT license.

README.md