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: 5.2.1
Branches Tags
scribe
ZIP TAR.GZ
Shalvah 7d1866bfcc 5.2.1 1 week ago
.github bf877ad674 Update GHA trigger 2 months ago
camel d65bb0d54d Update Flysystem usage 2 months ago
config c916109e48 Update strategy stubs 2 months ago
lang 7ad83bc02c Adjust indentation 1 year ago
resources e230a7f40e Default tryItOut base URL to display URL 3 months ago
routes 1a01b045e5 More Lumen cuts 2 months ago
src 7d1866bfcc 5.2.1 1 week ago
tests a9e7a668d7 Fix regressions in parsing validation rules 1 week ago
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files 3 years ago
.gitattributes c3a31009ba Support spatie/dto 3 3 years ago
.gitignore 7fa4283abc Drop Dingo 3 months ago
CHANGELOG.md 7d1866bfcc 5.2.1 1 week 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 2c2656fd05 Update README.md (#967) 1 month ago
composer.json 1839eb7890 Update deps 2 months ago
composer.lowest.json a2ac416350 Update lowest 2 months ago
composer.lowest.lock a2ac416350 Update lowest 2 months 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 40a623780c Upgrade 2 months ago
phpunit.xml 540f36ad59 Remove RouteRules strategy 3 months ago

README.md

Scribe

Latest Stable Version Total Downloads


v5 is out now!

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.

Contributing

Contributing is easy! See our contribution guide.