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

Shalvah dd99da03f2 Update ValidationRuleParsingTest.php 2 سال پیش
.github 042c2137e4 4.11.0 2 سال پیش
camel 8fe91d86e6 Expose default strategy for URL normalization 2 سال پیش
config 44996fe6f0 Support custom "Last updated at" label 2 سال پیش
resources fcbe079674 Clean up 2 سال پیش
routes 92c128171c Final cleanups 2 سال پیش
src da931ed01b Parse Enum rule 2 سال پیش
tests dd99da03f2 Update ValidationRuleParsingTest.php 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 750e949202 4.14.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 a431639965 Fix Laravel 10 compatibility 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.