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: d1a9a81509
Ramas Etiquetas
scribe
ZIP TAR.GZ
shalvah d1a9a81509 3.2.0 %!s(int64=3) %!d(string=hai) anos
.github 48fe4138ee Update bug_report.md %!s(int64=3) %!d(string=hai) anos
camel d79be99702 Theme fixes %!s(int64=3) %!d(string=hai) anos
config 75b0a0ea9c Update the doc url in config.php %!s(int64=3) %!d(string=hai) anos
resources d79be99702 Theme fixes %!s(int64=3) %!d(string=hai) anos
routes 412ad31c96 Switch to md compiler for example langs %!s(int64=4) %!d(string=hai) anos
src d1a9a81509 3.2.0 %!s(int64=3) %!d(string=hai) anos
tests badae4778d Fix Transformer status code type %!s(int64=3) %!d(string=hai) anos
.editorconfig 24d3f6aa22 Add some dotfiles %!s(int64=9) %!d(string=hai) anos
.gitattributes 6e60d14ea2 Make bodyParam parsing more rbust %!s(int64=6) %!d(string=hai) anos
.gitignore a81b4a86b9 Refactor tests %!s(int64=5) %!d(string=hai) anos
.travis.yml 9704c428f7 Simplify Dingo detection %!s(int64=4) %!d(string=hai) anos
CHANGELOG-1.x.md 516a96cf49 Switch to DTOs for parsing and writing Postman/OpenAPI %!s(int64=4) %!d(string=hai) anos
CHANGELOG-2.x.md 5433e4ba15 Implement inline validator support %!s(int64=4) %!d(string=hai) anos
CHANGELOG.md d1a9a81509 3.2.0 %!s(int64=3) %!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 277c56e553 3.0.1 %!s(int64=3) %!d(string=hai) anos
composer.dingo.json 1c51f9b41a Update README %!s(int64=3) %!d(string=hai) anos
composer.json 5433e4ba15 Implement inline validator support %!s(int64=4) %!d(string=hai) anos
logo-scribe.png 908fd36b04 Update doc %!s(int64=5) %!d(string=hai) anos
phpstan.neon 576a667c2d Fix linr %!s(int64=3) %!d(string=hai) anos
phpunit.xml 5433e4ba15 Implement inline validator support %!s(int64=4) %!d(string=hai) anos

README.md

Scribe

Latest Stable Version Total Downloads Build Status


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.