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: 8424ff53bb
Branche Tagy
scribe
ZIP TAR.GZ
Shalvah 8424ff53bb Phpstan fix 2 mesiacov pred
.github bf877ad674 Update GHA trigger 2 mesiacov pred
camel 37276c5ebc Update tests 3 mesiacov pred
config be1ca1f9a7 Clean up config file 2 mesiacov pred
lang 7ad83bc02c Adjust indentation 1 rok pred
resources e230a7f40e Default tryItOut base URL to display URL 3 mesiacov pred
routes 1a01b045e5 More Lumen cuts 2 mesiacov pred
src 065d9a097a Clean up 2 mesiacov pred
tests 353af36cdc Revert to old config 2 mesiacov pred
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files 3 rokov pred
.gitattributes c3a31009ba Support spatie/dto 3 3 rokov pred
.gitignore 7fa4283abc Drop Dingo 3 mesiacov pred
CHANGELOG.md 1ad707f229 4.40.0 3 mesiacov 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 9e20117eae Drop Lumen 3 mesiacov pred
composer.json 8424ff53bb Phpstan fix 2 mesiacov pred
composer.lowest.json 9e20117eae Drop Lumen 3 mesiacov 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 8424ff53bb Phpstan fix 2 mesiacov pred
phpunit.xml 540f36ad59 Remove RouteRules strategy 3 mesiacov 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 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.