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文档，则还需要了解更多信息。所以我为你做了一门课程。🤗

Árbore: ac9404ac12
Ramas Etiquetas
scribe
ZIP TAR.GZ
shalvah ac9404ac12 Add tests for laravel type %!s(int64=2) %!d(string=hai) anos
.github b9f9fa328f PHP 8 + Laravel 8 minimum %!s(int64=2) %!d(string=hai) anos
camel cc6c95eed2 Support multiple docs %!s(int64=3) %!d(string=hai) anos
config 5fc7d25319 Update scribe.php %!s(int64=3) %!d(string=hai) anos
resources de5f746e7e hide pre tag instead code tag on switching the language %!s(int64=2) %!d(string=hai) anos
routes b859f9ac7d Fix Lumen routing for docs (fixes #365) %!s(int64=3) %!d(string=hai) anos
src ac9404ac12 Add tests for laravel type %!s(int64=2) %!d(string=hai) anos
tests ac9404ac12 Add tests for laravel type %!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 ac9404ac12 Add tests for laravel type %!s(int64=2) %!d(string=hai) anos
.travis.yml c91eed5499 Update CI %!s(int64=3) %!d(string=hai) anos
CHANGELOG.md 9e3d35d83d 3.32.0 %!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 058559e9b2 Fix Ci %!s(int64=3) %!d(string=hai) anos
composer.dingo.json 3ea1bc647f Dingo and lowest deps %!s(int64=2) %!d(string=hai) anos
composer.json b9f9fa328f PHP 8 + Laravel 8 minimum %!s(int64=2) %!d(string=hai) anos
composer.lowest.json 3ea1bc647f Dingo and lowest deps %!s(int64=2) %!d(string=hai) anos
logo-scribe.png 908fd36b04 Update doc %!s(int64=5) %!d(string=hai) anos
phpstan.neon b9f9fa328f PHP 8 + Laravel 8 minimum %!s(int64=2) %!d(string=hai) anos
phpunit.xml d582cc5dfb Refactor tests/add tests for laravel type %!s(int64=2) %!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. 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.