Sākums Izpētīt Palīdzība
Reģistrēties Pierakstīties
wangjunyun
/
scribe
spogulis no https://github.com/knuckleswtf/scribe.git
1
0
Atdalīts 0
Faili Problēmas 0 Vikivietne

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

Koks: 6b4715b8cc
Atzari Tagi
scribe
ZIP TAR.GZ
Shalvah 6b4715b8cc 4.24.0 1 gadu atpakaļ
.github 8237b0df6a Create config.yml 1 gadu atpakaļ
camel 9b72f1ab01 Support limitng parameter values (enums) (#713) 1 gadu atpakaļ
config b32959d441 Support dynamic base URL (needs tests) (#723) 1 gadu atpakaļ
lang 7ad83bc02c Adjust indentation 1 gadu atpakaļ
resources b32959d441 Support dynamic base URL (needs tests) (#723) 1 gadu atpakaļ
routes 92c128171c Final cleanups 2 gadi atpakaļ
src 6b4715b8cc 4.24.0 1 gadu atpakaļ
tests e501a919f1 * auth.extra_info now propagates through to the security schema as description (#727) 1 gadu atpakaļ
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files 3 gadi atpakaļ
.gitattributes c3a31009ba Support spatie/dto 3 3 gadi atpakaļ
.gitignore ac9404ac12 Add tests for laravel type 2 gadi atpakaļ
.travis.yml c91eed5499 Update CI 3 gadi atpakaļ
CHANGELOG.md 6b4715b8cc 4.24.0 1 gadu atpakaļ
CONTRIBUTING.md 6457ea46f4 Add contribution guide 5 gadi atpakaļ
LICENSE.md 561dac8003 Refactor 2 gadi atpakaļ
README.md 3328b3d2dd Readme 2 gadi atpakaļ
composer.dingo.json 23a6583667 Refactor 2 gadi atpakaļ
composer.json f0ed95653b API resources: Infer model name from @mixin 1 gadu atpakaļ
composer.lowest.json 3ea1bc647f Dingo and lowest deps 2 gadi atpakaļ
logo-scribe.png 908fd36b04 Update doc 5 gadi atpakaļ
phpstan.neon 39f57d875b Fix lint 1 gadu atpakaļ
phpunit.xml ecfd1a18e5 Fix nested filters when generating examples for PHP, JS and Python 2 gadi atpakaļ

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.