Domovská stránka Prehľadávať Pomoc
Registrovať Prihlásiť sa
wangjunyun
/
scribe
zrkadlo https://github.com/knuckleswtf/scribe.git
1
0
Fork 0
Súbory Issues 0 Wiki

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

Strom: fdb8f4e5ca
Branche Tagy
scribe
ZIP TAR.GZ
shalvah fdb8f4e5ca Don't escape slashes in response content 2 rokov pred
.github 94d6ae2f00 Support multi-docs in `config:diff` 2 rokov pred
camel fdb8f4e5ca Don't escape slashes in response content 2 rokov pred
config 44996fe6f0 Support custom "Last updated at" label 2 rokov pred
resources 33c7a2e24b Remove unnecessary bracket in theme-default.style.css 2 rokov pred
routes 92c128171c Final cleanups 2 rokov pred
src 94d6ae2f00 Support multi-docs in `config:diff` 2 rokov pred
tests afc700b359 Add `scribe:config:diff` command 2 rokov pred
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files 3 rokov pred
.gitattributes c3a31009ba Support spatie/dto 3 3 rokov pred
.gitignore ac9404ac12 Add tests for laravel type 2 rokov pred
.travis.yml c91eed5499 Update CI 3 rokov pred
CHANGELOG.md c51adf3f82 4.6.1 2 rokov pred
CONTRIBUTING.md 6457ea46f4 Add contribution guide 5 rokov pred
LICENSE.md 561dac8003 Refactor 2 rokov pred
README.md 6c17082f2b - 2 rokov pred
composer.dingo.json 23a6583667 Refactor 2 rokov pred
composer.json e3092307da Fix bug in upgrader 2 rokov pred
composer.lowest.json 3ea1bc647f Dingo and lowest deps 2 rokov pred
logo-scribe.png 908fd36b04 Update doc 5 rokov pred
phpstan.neon 44996fe6f0 Support custom "Last updated at" label 2 rokov pred
phpunit.xml afc700b359 Add `scribe:config:diff` command 2 rokov pred

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

  • 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.