Inicio Explorar Axuda
Rexistro Iniciar sesión
wangjunyun
/
scribe
réplica de https://github.com/knuckleswtf/scribe.git
1
0
Fork 0
Ficheiros Incidencias 0 Wiki

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

Árbore: ea8badc788
Ramas Etiquetas
scribe
ZIP TAR.GZ
shalvah ea8badc788 Highlight sidebar item on navigation %!s(int64=2) %!d(string=hai) anos
.github d2b152627e Merge branch 'master' into v4 %!s(int64=2) %!d(string=hai) anos
camel 377eb64ff6 Clean up sort implementation %!s(int64=2) %!d(string=hai) anos
config 44996fe6f0 Support custom "Last updated at" label %!s(int64=2) %!d(string=hai) anos
resources ea8badc788 Highlight sidebar item on navigation %!s(int64=2) %!d(string=hai) anos
routes 92c128171c Final cleanups %!s(int64=2) %!d(string=hai) anos
src 1317b99cc9 Example requests and responses %!s(int64=2) %!d(string=hai) anos
tests 3152793064 Turn subgroups into folders in Postman collection %!s(int64=2) %!d(string=hai) anos
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files %!s(int64=3) %!d(string=hai) anos
.gitattributes c3a31009ba Support spatie/dto 3 %!s(int64=3) %!d(string=hai) anos
.gitignore ac9404ac12 Add tests for laravel type %!s(int64=3) %!d(string=hai) anos
.travis.yml c91eed5499 Update CI %!s(int64=4) %!d(string=hai) anos
CHANGELOG.md fca55860d8 4.1.0 %!s(int64=2) %!d(string=hai) anos
CONTRIBUTING.md 6457ea46f4 Add contribution guide %!s(int64=5) %!d(string=hai) anos
LICENSE.md 561dac8003 Refactor %!s(int64=2) %!d(string=hai) anos
README.md 561dac8003 Refactor %!s(int64=2) %!d(string=hai) anos
composer.dingo.json 23a6583667 Refactor %!s(int64=2) %!d(string=hai) anos
composer.json e3092307da Fix bug in upgrader %!s(int64=2) %!d(string=hai) anos
composer.lowest.json 3ea1bc647f Dingo and lowest deps %!s(int64=3) %!d(string=hai) anos
logo-scribe.png 908fd36b04 Update doc %!s(int64=5) %!d(string=hai) anos
phpstan.neon 44996fe6f0 Support custom "Last updated at" label %!s(int64=2) %!d(string=hai) anos
phpunit.xml 44996fe6f0 Support custom "Last updated at" label %!s(int64=2) %!d(string=hai) anos

README.md

Scribe

Latest Stable Version Total Downloads


v4 is out now!

Scribe helps you generate API documentation for humans from your Laravel/Lumen/Dingo codebase. See a live example at demo.scribe.knuckles.wtf.

Features

  • Pretty single-page HTML doc, with human-friendly text, code samples, and included in-browser API tester ("Try It Out")
  • Extracts body parameters details from FormRequests or validation rules
  • Safely calls API endpoints to get sample responses
  • Supports generating responses from Transformers or Eloquent API Resources
  • Generates Postman collection and OpenAPI spec
  • Easily customisable with custom views and included UI components
  • Easily extensible with custom strategies
  • Statically define extra endpoints that aren'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.