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: 25b68ccd86
Atzari Tagi
scribe
ZIP TAR.GZ
Shalvah 25b68ccd86 Merge pull request #576 from Peterragheb/feature/add-before-generating-hook 2 gadi atpakaļ
.github 94d6ae2f00 Support multi-docs in `config:diff` 2 gadi atpakaļ
camel fdb8f4e5ca Don't escape slashes in response content 2 gadi atpakaļ
config 44996fe6f0 Support custom "Last updated at" label 2 gadi atpakaļ
resources dbe8492a69 `default` theme: Show nested fields' short names in UI, since we now indent 2 gadi atpakaļ
routes 92c128171c Final cleanups 2 gadi atpakaļ
src 25b68ccd86 Merge pull request #576 from Peterragheb/feature/add-before-generating-hook 2 gadi atpakaļ
tests 25b68ccd86 Merge pull request #576 from Peterragheb/feature/add-before-generating-hook 2 gadi 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 7d2f163bb8 Changelog 2 gadi atpakaļ
CONTRIBUTING.md 6457ea46f4 Add contribution guide 5 gadi atpakaļ
LICENSE.md 561dac8003 Refactor 2 gadi atpakaļ
README.md 6c17082f2b - 2 gadi atpakaļ
composer.dingo.json 23a6583667 Refactor 2 gadi atpakaļ
composer.json e3092307da Fix bug in upgrader 2 gadi atpakaļ
composer.lowest.json 3ea1bc647f Dingo and lowest deps 2 gadi atpakaļ
logo-scribe.png 908fd36b04 Update doc 5 gadi atpakaļ
phpstan.neon 44996fe6f0 Support custom "Last updated at" label 2 gadi atpakaļ
phpunit.xml afc700b359 Add `scribe:config:diff` command 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

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