Почетна Преглед Помоћ
Регистрација Пријавите се
wangjunyun
/
scribe
огледало од https://github.com/knuckleswtf/scribe.git
1
0
Креирај огранак 0
Датотеке Дискусије 0 Вики

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

Дрво: 86dd0bde37
Гране Ознаке
scribe
ZIP TAR.GZ
Shalvah 86dd0bde37 Delete question.md пре 2 година
.github 86dd0bde37 Delete question.md пре 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.