Accueil Explorer Aide
S'inscrire Connexion
wangjunyun
/
scribe
miroir de https://github.com/knuckleswtf/scribe.git
1
0
Fork 0
Fichiers Tickets 0 Wiki

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

Aborescence: 4.37.2
Branches Tags
scribe
ZIP TAR.GZ
Shalvah 6318f3f68c 4.37.2 il y a 8 mois
.github e41b0d75ea Adjust CI il y a 1 an
camel 88b6c67c49 Allow examples to be shown in response fields (#825) il y a 1 an
config b856570df1 Better tests + fixes for route rules vs strategy config il y a 10 mois
lang 7ad83bc02c Adjust indentation il y a 1 an
resources a98476b031 Update theme-default.style.css (#868) il y a 8 mois
routes 92c128171c Final cleanups il y a 2 ans
src 6318f3f68c 4.37.2 il y a 8 mois
tests 87c2dbd89a fix: multiple responses with the same status code (#863) il y a 10 mois
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files il y a 3 ans
.gitattributes c3a31009ba Support spatie/dto 3 il y a 3 ans
.gitignore ac9404ac12 Add tests for laravel type il y a 2 ans
CHANGELOG.md 6318f3f68c 4.37.2 il y a 8 mois
CONTRIBUTING.md af8384feaf Update contribution guide link (#805) il y a 1 an
Dockerfile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) il y a 1 an
LICENSE.md 561dac8003 Refactor il y a 2 ans
Makefile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) il y a 1 an
README.md cb258f6e91 Update/fix migration URL in README. Remove errant backtick (#785) il y a 1 an
composer.dingo.json 266326f05e Support php-parser v5 il y a 1 an
composer.json 138a47bed7 feat: Add Laravel 11 Support (#812) il y a 1 an
composer.lowest.json 266326f05e Support php-parser v5 il y a 1 an
docker-compose.yml 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) il y a 1 an
logo-scribe.png 908fd36b04 Update doc il y a 5 ans
phpstan.neon 39f57d875b Fix lint il y a 1 an
phpunit.xml 57b55ec1ce Support matching routes on method + path il y a 1 an

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.