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

Shalvah 2c730e0a1c Update index.md vor 5 Jahren
config bb3d511133 Fix synax for 7.2 support vor 5 Jahren
docs 2c730e0a1c Update index.md vor 5 Jahren
resources b252f8bf7c Change auth badge to lowercase, fix lint vor 5 Jahren
routes 277f3d1080 Rename project to Scribe vor 5 Jahren
src 6b57d4766d Fix dingo tests vor 5 Jahren
tests 6b57d4766d Fix dingo tests vor 5 Jahren
.editorconfig 24d3f6aa22 Add some dotfiles vor 9 Jahren
.gitattributes 6e60d14ea2 Make bodyParam parsing more rbust vor 6 Jahren
.gitignore 277f3d1080 Rename project to Scribe vor 5 Jahren
.styleci.yml 385fbc7ba0 Fix style vor 5 Jahren
.travis.yml d6100fcf5f Switch to clara for logging vor 5 Jahren
CHANGELOG.md 221018765b Fix tests vor 5 Jahren
CONTRIBUTING.md 4c87b21d29 Update CONTRIBUTING.md vor 6 Jahren
LICENSE.md 0e25996b83 Initial commit vor 9 Jahren
README.md 967e528531 Update README.md vor 5 Jahren
body_params_1.png b7aad444e3 Update docs on urlParams vor 5 Jahren
body_params_2.png b7aad444e3 Update docs on urlParams vor 5 Jahren
composer.dingo.json 286c39bf16 Fix tests vor 5 Jahren
composer.json 3e99d5b74f Update deps vor 5 Jahren
phpstan.neon f7407a5105 Fix lint, little fixes vor 5 Jahren
phpunit.xml b804f02e7c Add support for multiple scenario descriptions in @response tag vor 5 Jahren
todo.md 3eb73b80bc Update todo.md vor 5 Jahren

README.md

Scribe ✍

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

Latest Stable Version Total Downloads Build Status

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/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 mpociot/laravel-apidoc-generator.