Domů Procházet Nápověda
Registrovat se Přihlásit se
wangjunyun
/
scribe
zrcadlo https://github.com/knuckleswtf/scribe.git
1
0
Rozštěpit 0
Soubory Úkoly 0 Wiki

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

Strom: 3fb9872fa6
Větve Značky
scribe
ZIP TAR.GZ
shalvah 3fb9872fa6 Add `instantiateFormRequestUsing` hook před 3 roky
.github 4570c2aa9f Fix tests on lowest před 3 roky
camel 60e421cdde Fix tests před 3 roky
config 25cbdc193f Add prerequest hook před 3 roky
resources ce94c03966 Ifx JS error (closes #416) před 3 roky
routes b859f9ac7d Fix Lumen routing for docs (fixes #365) před 3 roky
src 3fb9872fa6 Add `instantiateFormRequestUsing` hook před 3 roky
tests 3fb9872fa6 Add `instantiateFormRequestUsing` hook před 3 roky
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files před 3 roky
.gitattributes c3a31009ba Support spatie/dto 3 před 3 roky
.gitignore a81b4a86b9 Refactor tests před 5 roky
.travis.yml c91eed5499 Update CI před 3 roky
CHANGELOG.md 7a3d9feec5 3.23.0 před 3 roky
CONTRIBUTING.md 6457ea46f4 Add contribution guide před 5 roky
LICENSE.md d1a9a81509 3.2.0 před 3 roky
README.md 058559e9b2 Fix Ci před 3 roky
composer.dingo.json 528781c1b3 Update composer.dingo.json před 3 roky
composer.json 8f64a3c14f Merge remote-tracking branch 'origin/master' před 3 roky
composer.lowest.json 4570c2aa9f Fix tests on lowest před 3 roky
logo-scribe.png 908fd36b04 Update doc před 5 roky
phpstan.neon 3fb9872fa6 Add `instantiateFormRequestUsing` hook před 3 roky
phpunit.xml 710dd8c711 Add failing test for underscore resource params před 3 roky

README.md

Scribe

Latest Stable Version Total Downloads


v3 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. There's a Node.js version, too!

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.

v2 docs (PHP 7.2+, not actively maintained) 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.