Scribe可以帮助您自动生成文档，但是如果您真的想制作友好，可维护和可测试的API文档，则还需要了解更多信息。所以我为你做了一门课程。🤗
Shalvah
9ee611163e
Merge pull request #69 from fabiofdsantos/patch-3
|
4 年之前 | |
|---|---|---|
| .github | 4 年之前 | |
| config | 4 年之前 | |
| docs | 4 年之前 | |
| resources | 5 年之前 | |
| routes | 5 年之前 | |
| src | 4 年之前 | |
| tests | 4 年之前 | |
| .editorconfig | 9 年之前 | |
| .gitattributes | 6 年之前 | |
| .gitignore | 5 年之前 | |
| .styleci.yml | 5 年之前 | |
| .travis.yml | 5 年之前 | |
| CHANGELOG.0-1.md | 5 年之前 | |
| CHANGELOG.md | 4 年之前 | |
| CONTRIBUTING.md | 5 年之前 | |
| LICENSE.md | 4 年之前 | |
| README.md | 4 年之前 | |
| composer.dingo.json | 5 年之前 | |
| composer.json | 5 年之前 | |
| logo-scribe.png | 5 年之前 | |
| phpstan.neon | 4 年之前 | |
| phpunit.xml | 5 年之前 | |
| todo.md | 5 年之前 |
README.md
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.
Installation
PHP 7.2.5 and Laravel/Lumen 5.8 or higher are required.
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/scribeinstead (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.phpto your project asconfig/scribe.php. Then add to yourbootstrap/app.php:
$app->configure('scribe');
Contributing
Contributing is easy! See our contribution guide.