Etusivu Tutki Apua
Rekisteröidy Kirjaudu sisään
wangjunyun
/
scribe
peilaus alkaen https://github.com/knuckleswtf/scribe.git
1
0
Fork 0
Tiedostot Ongelmat 0 Wiki

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

Puu: 0c16c0aa4d
Branchit Tagit
scribe
ZIP TAR.GZ
shalvah 0c16c0aa4d Changelog 4 vuotta sitten
.github 5a5e67c17c Update bug_report.md 4 vuotta sitten
camel 683e9694fa Implement sorting of endpoints 4 vuotta sitten
config 6e1a7e743c Support query parameters in validation rules extraction 4 vuotta sitten
resources 624f8ecef5 Rename md and blade templates 4 vuotta sitten
routes 412ad31c96 Switch to md compiler for example langs 4 vuotta sitten
src 576a667c2d Fix linr 4 vuotta sitten
tests 624f8ecef5 Rename md and blade templates 4 vuotta sitten
.editorconfig 24d3f6aa22 Add some dotfiles 9 vuotta sitten
.gitattributes 6e60d14ea2 Make bodyParam parsing more rbust 6 vuotta sitten
.gitignore a81b4a86b9 Refactor tests 5 vuotta sitten
.travis.yml 9704c428f7 Simplify Dingo detection 4 vuotta sitten
CHANGELOG-1.x.md 516a96cf49 Switch to DTOs for parsing and writing Postman/OpenAPI 4 vuotta sitten
CHANGELOG-2.x.md 5433e4ba15 Implement inline validator support 4 vuotta sitten
CHANGELOG.md 0c16c0aa4d Changelog 4 vuotta sitten
CONTRIBUTING.md 6457ea46f4 Add contribution guide 5 vuotta sitten
LICENSE.md 437504e237 Update license 4 vuotta sitten
README.md 1c51f9b41a Update README 4 vuotta sitten
composer.dingo.json 1c51f9b41a Update README 4 vuotta sitten
composer.json 5433e4ba15 Implement inline validator support 4 vuotta sitten
logo-scribe.png 908fd36b04 Update doc 5 vuotta sitten
phpstan.neon 576a667c2d Fix linr 4 vuotta sitten
phpunit.xml 5433e4ba15 Implement inline validator support 4 vuotta sitten

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.