Почетна Преглед Помоћ
Регистрација Пријавите се
wangjunyun
/
scribe
огледало од https://github.com/knuckleswtf/scribe.git
1
0
Креирај огранак 0
Датотеке Дискусије 0 Вики

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

Дрво: 1c51f9b41a
Гране Ознаке
scribe
ZIP TAR.GZ
shalvah 1c51f9b41a Update README пре 4 година
.github 5a5e67c17c Update bug_report.md пре 4 година
camel 412ad31c96 Switch to md compiler for example langs пре 4 година
config 6a61de0cf7 Improve factory relation generation пре 4 година
docs 9704c428f7 Simplify Dingo detection пре 4 година
resources c353248f5d Refactor themes and examples пре 4 година
routes 412ad31c96 Switch to md compiler for example langs пре 4 година
src c353248f5d Refactor themes and examples пре 4 година
tests 9d8f4024d9 Switch from filemtimes to file hashes пре 4 година
.editorconfig 24d3f6aa22 Add some dotfiles пре 9 година
.gitattributes 6e60d14ea2 Make bodyParam parsing more rbust пре 6 година
.gitignore a81b4a86b9 Refactor tests пре 5 година
.travis.yml 9704c428f7 Simplify Dingo detection пре 4 година
CHANGELOG-1.x.md 516a96cf49 Switch to DTOs for parsing and writing Postman/OpenAPI пре 4 година
CHANGELOG-2.x.md 5433e4ba15 Implement inline validator support пре 4 година
CHANGELOG.md 412ad31c96 Switch to md compiler for example langs пре 4 година
CONTRIBUTING.md 6457ea46f4 Add contribution guide пре 5 година
LICENSE.md 437504e237 Update license пре 4 година
README.md 1c51f9b41a Update README пре 4 година
composer.dingo.json 1c51f9b41a Update README пре 4 година
composer.json 5433e4ba15 Implement inline validator support пре 4 година
logo-scribe.png 908fd36b04 Update doc пре 5 година
phpstan.neon d59b274988 Fix lint пре 4 година
phpunit.xml 5433e4ba15 Implement inline validator support пре 4 година

README.md

Scribe


Still on v2? Here's the v3 migration guide.

Scribe helps you generate API documentation for humans from your Laravel/Lumen/Dingo codebase. See a live example at demo.scribe.knuckles.wtf. There's a Node.js version, too!

Latest Stable Version Total Downloads Build Status

👋 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.🤗

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

Documentation

Check out the documentation at scribe.knuckles.wtf/laravel.

v2 docs (unmaintained) are at scribe.rtfd.io.

If you're coming from mpociot/laravel-apidoc-generator, there's a migration guide.

Contributing

Contributing is easy! See our contribution guide.