Domovská stránka Prehľadávať Pomoc
Registrovať Prihlásiť sa
wangjunyun
/
scribe
zrkadlo https://github.com/knuckleswtf/scribe.git
1
0
Fork 0
Súbory Issues 0 Wiki

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

Strom: 4.30.0
Branche Tagy
scribe
ZIP TAR.GZ
Shalvah a92f7fac2e 4.30.0 1 rok pred
.github e41b0d75ea Adjust CI 1 rok pred
camel fea04b1afe Fix tests 1 rok pred
config a04d1773c3 External UI improvements (#780) 1 rok pred
lang 7ad83bc02c Adjust indentation 1 rok pred
resources a04d1773c3 External UI improvements (#780) 1 rok pred
routes 92c128171c Final cleanups 2 rokov pred
src 19b1da2e2e 4.30.0 1 rok pred
tests efd6f6ce18 Auto-migrate old route rules to new settings 1 rok pred
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files 3 rokov pred
.gitattributes c3a31009ba Support spatie/dto 3 3 rokov pred
.gitignore ac9404ac12 Add tests for laravel type 2 rokov pred
.travis.yml c91eed5499 Update CI 3 rokov pred
CHANGELOG.md a92f7fac2e 4.30.0 1 rok pred
CONTRIBUTING.md af8384feaf Update contribution guide link (#805) 1 rok pred
Dockerfile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) 1 rok pred
LICENSE.md 561dac8003 Refactor 2 rokov pred
Makefile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) 1 rok pred
README.md cb258f6e91 Update/fix migration URL in README. Remove errant backtick (#785) 1 rok pred
composer.dingo.json c520156dd8 chore: allow nikic/php-parse v5 (#795) 1 rok pred
composer.json c520156dd8 chore: allow nikic/php-parse v5 (#795) 1 rok pred
composer.lowest.json c520156dd8 chore: allow nikic/php-parse v5 (#795) 1 rok pred
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 rok pred
logo-scribe.png 908fd36b04 Update doc 5 rokov pred
phpstan.neon 39f57d875b Fix lint 1 rok pred
phpunit.xml 57b55ec1ce Support matching routes on method + path 1 rok pred

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.