Domů Procházet Nápověda
Registrovat se Přihlásit se
wangjunyun
/
scribe
zrcadlo https://github.com/knuckleswtf/scribe.git
1
0
Rozštěpit 0
Soubory Úkoly 0 Wiki

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

Strom: c0afe84008
Větve Značky
scribe
ZIP TAR.GZ
Shalvah c0afe84008 4.33.0 před 1 rokem
.github e41b0d75ea Adjust CI před 1 rokem
camel fea04b1afe Fix tests před 1 rokem
config a04d1773c3 External UI improvements (#780) před 1 rokem
lang 7ad83bc02c Adjust indentation před 1 rokem
resources 4811b00bf9 Fixes #810 (#815) před 1 rokem
routes 92c128171c Final cleanups před 2 roky
src c0afe84008 4.33.0 před 1 rokem
tests efd6f6ce18 Auto-migrate old route rules to new settings před 1 rokem
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files před 3 roky
.gitattributes c3a31009ba Support spatie/dto 3 před 3 roky
.gitignore ac9404ac12 Add tests for laravel type před 2 roky
.travis.yml c91eed5499 Update CI před 3 roky
CHANGELOG.md c0afe84008 4.33.0 před 1 rokem
CONTRIBUTING.md af8384feaf Update contribution guide link (#805) před 1 rokem
Dockerfile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) před 1 rokem
LICENSE.md 561dac8003 Refactor před 2 roky
Makefile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) před 1 rokem
README.md cb258f6e91 Update/fix migration URL in README. Remove errant backtick (#785) před 1 rokem
composer.dingo.json 266326f05e Support php-parser v5 před 1 rokem
composer.json 138a47bed7 feat: Add Laravel 11 Support (#812) před 1 rokem
composer.lowest.json 266326f05e Support php-parser v5 před 1 rokem
docker-compose.yml 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) před 1 rokem
logo-scribe.png 908fd36b04 Update doc před 5 roky
phpstan.neon 39f57d875b Fix lint před 1 rokem
phpunit.xml 57b55ec1ce Support matching routes on method + path před 1 rokem

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.