Home Explore Help
Register Sign In
wangjunyun
/
scribe
mirror of https://github.com/knuckleswtf/scribe.git
1
0
Fork 0
Files Issues 0 Wiki

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

Tree: 1ad707f229
Branches Tags
scribe
ZIP TAR.GZ
Shalvah 1ad707f229 4.40.0 3 months ago
.github e41b0d75ea Adjust CI 1 year ago
camel a6aee1d561 feat: add required to responseField tag and append the required fields to generateResponseContentSpec for object types (#814) 6 months ago
config f00f6bffa7 Update scribe.php (#928) 4 months ago
lang 7ad83bc02c Adjust indentation 1 year ago
resources a26d9c912a render laravel dd() dump output properly (#893) 7 months ago
routes 92c128171c Final cleanups 2 years ago
src 1ad707f229 4.40.0 3 months ago
tests 99b71ebf05 Fix missing required list in OpenAPI for nested body params 3 months ago
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files 3 years ago
.gitattributes c3a31009ba Support spatie/dto 3 3 years ago
.gitignore ac9404ac12 Add tests for laravel type 2 years ago
CHANGELOG.md 1ad707f229 4.40.0 3 months ago
CONTRIBUTING.md af8384feaf Update contribution guide link (#805) 1 year ago
Dockerfile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) 1 year ago
LICENSE.md 561dac8003 Refactor 2 years ago
Makefile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) 1 year ago
README.md cb258f6e91 Update/fix migration URL in README. Remove errant backtick (#785) 1 year ago
composer.dingo.json 266326f05e Support php-parser v5 1 year ago
composer.json 138a47bed7 feat: Add Laravel 11 Support (#812) 1 year ago
composer.lowest.json 266326f05e Support php-parser v5 1 year ago
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 year ago
logo-scribe.png 908fd36b04 Update doc 5 years ago
phpstan.neon 39f57d875b Fix lint 1 year ago
phpunit.xml 57b55ec1ce Support matching routes on method + path 1 year ago

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.