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: 16c7f6686f
Větve Značky
scribe
ZIP TAR.GZ
Shalvah 16c7f6686f Update workflow version před 3 měsíci
.github 16c7f6686f Update workflow version před 3 měsíci
camel a6aee1d561 feat: add required to responseField tag and append the required fields to generateResponseContentSpec for object types (#814) před 6 měsíci
config 7fa4283abc Drop Dingo před 3 měsíci
lang 7ad83bc02c Adjust indentation před 1 rokem
resources a26d9c912a render laravel dd() dump output properly (#893) před 7 měsíci
routes 92c128171c Final cleanups před 2 roky
src 9e20117eae Drop Lumen před 3 měsíci
tests 7fa4283abc Drop Dingo před 3 měsíci
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files před 3 roky
.gitattributes c3a31009ba Support spatie/dto 3 před 3 roky
.gitignore 7fa4283abc Drop Dingo před 3 měsíci
CHANGELOG.md cb4c2e552f 4.39.0 před 4 měsíci
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 9e20117eae Drop Lumen před 3 měsíci
composer.json 9e20117eae Drop Lumen před 3 měsíci
composer.lowest.json 9e20117eae Drop Lumen před 3 měsíci
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 7fa4283abc Drop Dingo před 3 měsíci
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 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.