Trang chủ Khám phá Trợ giúp
Đăng ký Đăng nhập
wangjunyun
/
scribe
mirror of https://github.com/knuckleswtf/scribe.git
1
0
Fork 0
Các tập tin Các vấn đề 0 Wiki

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

Tree: 16c7f6686f
Branches Tags
scribe
ZIP TAR.GZ
Shalvah 16c7f6686f Update workflow version 3 tháng trước cách đây
.github 16c7f6686f Update workflow version 3 tháng trước cách đây
camel a6aee1d561 feat: add required to responseField tag and append the required fields to generateResponseContentSpec for object types (#814) 6 tháng trước cách đây
config 7fa4283abc Drop Dingo 3 tháng trước cách đây
lang 7ad83bc02c Adjust indentation 1 năm trước cách đây
resources a26d9c912a render laravel dd() dump output properly (#893) 7 tháng trước cách đây
routes 92c128171c Final cleanups 2 năm trước cách đây
src 9e20117eae Drop Lumen 3 tháng trước cách đây
tests 7fa4283abc Drop Dingo 3 tháng trước cách đây
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files 3 năm trước cách đây
.gitattributes c3a31009ba Support spatie/dto 3 3 năm trước cách đây
.gitignore 7fa4283abc Drop Dingo 3 tháng trước cách đây
CHANGELOG.md cb4c2e552f 4.39.0 4 tháng trước cách đây
CONTRIBUTING.md af8384feaf Update contribution guide link (#805) 1 năm trước cách đây
Dockerfile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) 1 năm trước cách đây
LICENSE.md 561dac8003 Refactor 2 năm trước cách đây
Makefile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) 1 năm trước cách đây
README.md 9e20117eae Drop Lumen 3 tháng trước cách đây
composer.json 9e20117eae Drop Lumen 3 tháng trước cách đây
composer.lowest.json 9e20117eae Drop Lumen 3 tháng trước cách đây
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 năm trước cách đây
logo-scribe.png 908fd36b04 Update doc 5 năm trước cách đây
phpstan.neon 7fa4283abc Drop Dingo 3 tháng trước cách đây
phpunit.xml 57b55ec1ce Support matching routes on method + path 1 năm trước cách đây

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.