Inicio Explorar Axuda
Rexistro Iniciar sesión
wangjunyun
/
scribe
réplica de https://github.com/knuckleswtf/scribe.git
1
0
Fork 0
Ficheiros Incidencias 0 Wiki

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

Rama: v3
Ramas Etiquetas
scribe
ZIP TAR.GZ
shalvah 74c483d8f1 3.37.2 %!s(int64=2) %!d(string=hai) anos
.github 4b3e48d80f 3.37.1 %!s(int64=2) %!d(string=hai) anos
camel a41e71707b Multi-docs: Use correct routes in Laravel view %!s(int64=2) %!d(string=hai) anos
config 5fc7d25319 Update scribe.php %!s(int64=3) %!d(string=hai) anos
resources ba94ab9244 fix: 🐛 empty query parameter sent even if input is empty %!s(int64=2) %!d(string=hai) anos
routes b859f9ac7d Fix Lumen routing for docs (fixes #365) %!s(int64=3) %!d(string=hai) anos
src a41e71707b Multi-docs: Use correct routes in Laravel view %!s(int64=2) %!d(string=hai) anos
tests cec35efd32 [Feature] No-example value with formRequest bodyParameter and queryParameter %!s(int64=2) %!d(string=hai) anos
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files %!s(int64=3) %!d(string=hai) anos
.gitattributes c3a31009ba Support spatie/dto 3 %!s(int64=3) %!d(string=hai) anos
.gitignore a81b4a86b9 Refactor tests %!s(int64=5) %!d(string=hai) anos
.travis.yml c91eed5499 Update CI %!s(int64=3) %!d(string=hai) anos
CHANGELOG.md 74c483d8f1 3.37.2 %!s(int64=2) %!d(string=hai) anos
CONTRIBUTING.md 6457ea46f4 Add contribution guide %!s(int64=5) %!d(string=hai) anos
LICENSE.md d1a9a81509 3.2.0 %!s(int64=3) %!d(string=hai) anos
README.md 984dfbd3c3 Update README.md %!s(int64=2) %!d(string=hai) anos
composer.dingo.json 528781c1b3 Update composer.dingo.json %!s(int64=3) %!d(string=hai) anos
composer.json 8f64a3c14f Merge remote-tracking branch 'origin/master' %!s(int64=3) %!d(string=hai) anos
composer.lowest.json 4570c2aa9f Fix tests on lowest %!s(int64=3) %!d(string=hai) anos
logo-scribe.png 908fd36b04 Update doc %!s(int64=5) %!d(string=hai) anos
phpstan.neon 185b327dd8 Fix CI %!s(int64=2) %!d(string=hai) anos
phpunit.xml 710dd8c711 Add failing test for underscore resource params %!s(int64=3) %!d(string=hai) anos

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.

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.