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

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

Дрво: c0afe84008
Гране Ознаке
scribe
ZIP TAR.GZ
Shalvah c0afe84008 4.33.0 пре 1 година
.github e41b0d75ea Adjust CI пре 1 година
camel fea04b1afe Fix tests пре 1 година
config a04d1773c3 External UI improvements (#780) пре 1 година
lang 7ad83bc02c Adjust indentation пре 1 година
resources 4811b00bf9 Fixes #810 (#815) пре 1 година
routes 92c128171c Final cleanups пре 2 година
src c0afe84008 4.33.0 пре 1 година
tests efd6f6ce18 Auto-migrate old route rules to new settings пре 1 година
.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 c0afe84008 4.33.0 пре 1 година
CONTRIBUTING.md af8384feaf Update contribution guide link (#805) пре 1 година
Dockerfile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) пре 1 година
LICENSE.md 561dac8003 Refactor пре 2 година
Makefile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) пре 1 година
README.md cb258f6e91 Update/fix migration URL in README. Remove errant backtick (#785) пре 1 година
composer.dingo.json 266326f05e Support php-parser v5 пре 1 година
composer.json 138a47bed7 feat: Add Laravel 11 Support (#812) пре 1 година
composer.lowest.json 266326f05e Support php-parser v5 пре 1 година
docker-compose.yml 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) пре 1 година
logo-scribe.png 908fd36b04 Update doc пре 5 година
phpstan.neon 39f57d875b Fix lint пре 1 година
phpunit.xml 57b55ec1ce Support matching routes on method + path пре 1 година

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

  • Useful output:
    • Pretty single-page HTML doc, with human-friendly text, code samples, and in-browser API tester ("Try It Out")
    • Generates Postman collection and OpenAPI spec
  • Smarts. Scribe can:
    • extract request parameter details from FormRequests or validation rules
    • safely call API endpoints to get sample responses
    • generate sample responses from Eloquent API Resources or Transformers
  • Customisable to different levels:
    • Customise the UI by adjusting text, ordering, examples, or change the UI itself
    • Add custom strategies to adjust how data is extracted
    • Statically define extra endpoints or information that isn'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.