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

176 Rilis

Shalvah 9ee611163e Merge pull request #69 from fabiofdsantos/patch-3		4 tahun lalu
.github	ad79a518c8 Update pull request template	5 tahun lalu
config	fc7161a08e Update docs for continue_without_database_transactions	5 tahun lalu
docs	64b5294ab7 Update docs/guide-getting-started.md	4 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	56c3fd4c61 Update docs	4 tahun lalu
tests	db1e559e22 Merge pull request #43 from chriserikhaugli/#40-Include-raw-in-requests.url	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	7e588d52cf Update CHANGELOG.md	5 tahun lalu
CONTRIBUTING.md	6457ea46f4 Add contribution guide	5 tahun lalu
LICENSE.md	437504e237 Update license	4 tahun lalu
README.md	56c3fd4c61 Update docs	4 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	86ce875d44 Fix lint	4 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.

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

Documentation

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.