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

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

shalvah 0c8afe8d54 Parallel testing with paratest		5 yıl önce
config	afccb86451 Add ability to automatically extract fields from response	5 yıl önce
docs	d7d2acd1ee Implement new system for tracking and responding to modifications to files; remove update command	5 yıl önce
resources	afccb86451 Add ability to automatically extract fields from response	5 yıl önce
routes	277f3d1080 Rename project to Scribe	5 yıl önce
src	afccb86451 Add ability to automatically extract fields from response	5 yıl önce
tests	221018765b Fix tests	5 yıl önce
.editorconfig	24d3f6aa22 Add some dotfiles	9 yıl önce
.gitattributes	6e60d14ea2 Make bodyParam parsing more rbust	6 yıl önce
.gitignore	277f3d1080 Rename project to Scribe	5 yıl önce
.styleci.yml	385fbc7ba0 Fix style	5 yıl önce
.travis.yml	d6100fcf5f Switch to clara for logging	5 yıl önce
CHANGELOG.md	221018765b Fix tests	5 yıl önce
CONTRIBUTING.md	4c87b21d29 Update CONTRIBUTING.md	6 yıl önce
LICENSE.md	0e25996b83 Initial commit	9 yıl önce
README.md	863259386b Allow indication of binary responses (fix mpociot/laravel-apidoc-generator#479)	5 yıl önce
body_params_1.png	b7aad444e3 Update docs on urlParams	5 yıl önce
body_params_2.png	b7aad444e3 Update docs on urlParams	5 yıl önce
composer.dingo.json	0c8afe8d54 Parallel testing with paratest	5 yıl önce
composer.json	0c8afe8d54 Parallel testing with paratest	5 yıl önce
phpstan.neon	28b89de019 Ignore errors relating to Dingo when linting	5 yıl önce
phpunit.xml	0c8afe8d54 Parallel testing with paratest	5 yıl önce

Scribe ✍

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

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

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 v3 to v4.

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