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

Shalvah 7c6001ad8d Create question.yml 2 лет назад
.github 7c6001ad8d Create question.yml 2 лет назад
camel 8fe91d86e6 Expose default strategy for URL normalization 2 лет назад
config 44996fe6f0 Support custom "Last updated at" label 2 лет назад
resources 5e2b8bced4 Remove invalid JS file request (closes #634) 2 лет назад
routes 92c128171c Final cleanups 2 лет назад
src a19dbd0a28 Add missing dontTouch to scribe:generate 2 лет назад
tests df4d86fa1d Experimental: don't URL-encode Postman query parameters (closes #442) 2 лет назад
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files 3 лет назад
.gitattributes c3a31009ba Support spatie/dto 3 3 лет назад
.gitignore ac9404ac12 Add tests for laravel type 2 лет назад
.travis.yml c91eed5499 Update CI 3 лет назад
CHANGELOG.md edc14a9800 4.17.0 2 лет назад
CONTRIBUTING.md 6457ea46f4 Add contribution guide 5 лет назад
LICENSE.md 561dac8003 Refactor 2 лет назад
README.md 6c17082f2b - 2 лет назад
composer.dingo.json 23a6583667 Refactor 2 лет назад
composer.json ea341869b4 Support invokable rules correctly (closes #629), support Laravel 10 ValidationRule 2 лет назад
composer.lowest.json 3ea1bc647f Dingo and lowest deps 2 лет назад
logo-scribe.png 908fd36b04 Update doc 5 лет назад
phpstan.neon 9a02fdb91b Fix build 2 лет назад
phpunit.xml ecfd1a18e5 Fix nested filters when generating examples for PHP, JS and Python 2 лет назад

README.md

Scribe

Latest Stable Version Total Downloads


v4 is out now! Featuring subgroups, easier sorting, and an automated upgrade command.

Scribe helps you generate API documentation for humans from your Laravel/Lumen/Dingo codebase. See a live example at demo.scribe.knuckles.wtf.

Features

  • Pretty single-page HTML doc, with human-friendly text, code samples, and included in-browser API tester ("Try It Out")
  • Extracts body parameters details from FormRequests or validation rules
  • Safely calls API endpoints to get sample responses
  • Supports generating responses from Transformers or Eloquent API Resources
  • Generates Postman collection and OpenAPI spec
  • Easily customisable with custom views and included UI components
  • Easily extensible with custom strategies
  • Statically define extra endpoints that aren't in your codebase

👋 Scribe helps you generate docs automatically, but if you really want to make friendly, maintainable and testable API docs, there's some more things you need to know. So I made a course for you.🤗

Documentation

Check out the documentation at scribe.knuckles.wtf/laravel.

If you're coming from mpociot/laravel-apidoc-generator, first migrate to v3`, then to v4.

Contributing

Contributing is easy! See our contribution guide.