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

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

shalvah 17b45b1e71 Update doc		преди 5 години
config	1b3ad6eda1 (re-)Add support for extracting body parameter information from FormRequests	преди 5 години
docs	955b17919b Update doc	преди 5 години
resources	6a0bdbab84 Add ability to customise intro text	преди 5 години
routes	277f3d1080 Rename project to Scribe	преди 5 години
src	1b3ad6eda1 (re-)Add support for extracting body parameter information from FormRequests	преди 5 години
tests	1b3ad6eda1 (re-)Add support for extracting body parameter information from FormRequests	преди 5 години
.editorconfig	24d3f6aa22 Add some dotfiles	преди 9 години
.gitattributes	6e60d14ea2 Make bodyParam parsing more rbust	преди 6 години
.gitignore	277f3d1080 Rename project to Scribe	преди 5 години
.styleci.yml	385fbc7ba0 Fix style	преди 5 години
.travis.yml	d6100fcf5f Switch to clara for logging	преди 5 години
CHANGELOG.md	221018765b Fix tests	преди 5 години
CONTRIBUTING.md	4c87b21d29 Update CONTRIBUTING.md	преди 6 години
LICENSE.md	0e25996b83 Initial commit	преди 9 години
README.md	17b45b1e71 Update doc	преди 5 години
body_params_1.png	b7aad444e3 Update docs on urlParams	преди 5 години
body_params_2.png	b7aad444e3 Update docs on urlParams	преди 5 години
composer.dingo.json	0c8afe8d54 Parallel testing with paratest	преди 5 години
composer.json	0c8afe8d54 Parallel testing with paratest	преди 5 години
phpstan.neon	28b89de019 Ignore errors relating to Dingo when linting	преди 5 години
phpunit.xml	b804f02e7c Add support for multiple scenario descriptions in @response tag	преди 5 години
todo.md	955b17919b Update doc	преди 5 години

Scribe ✍

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

Installation

PHP 7.2 and Laravel/Lumen 6 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