Home Esplora Aiuto
Registrati Accedi
wangjunyun
/
scribe
mirror da https://github.com/knuckleswtf/scribe.git
1
0
Forka 0
File Problemi 0 Wiki

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

Albero (Tree): 3891e06d6d
Rami (Branch) Tag
scribe
ZIP TAR.GZ
shalvah 3891e06d6d 3.37.1 2 anni fa
.github 3891e06d6d 3.37.1 2 anni fa
camel 97065d9b65 Refactor URL params normalization 2 anni fa
config 5fc7d25319 Update scribe.php 3 anni fa
resources ba94ab9244 fix: 🐛 empty query parameter sent even if input is empty 2 anni fa
routes b859f9ac7d Fix Lumen routing for docs (fixes #365) 3 anni fa
src 3891e06d6d 3.37.1 2 anni fa
tests cec35efd32 [Feature] No-example value with formRequest bodyParameter and queryParameter 2 anni fa
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files 3 anni fa
.gitattributes c3a31009ba Support spatie/dto 3 3 anni fa
.gitignore a81b4a86b9 Refactor tests 5 anni fa
.travis.yml c91eed5499 Update CI 3 anni fa
CHANGELOG.md 3891e06d6d 3.37.1 2 anni fa
CONTRIBUTING.md 6457ea46f4 Add contribution guide 5 anni fa
LICENSE.md d1a9a81509 3.2.0 3 anni fa
README.md 984dfbd3c3 Update README.md 2 anni fa
composer.dingo.json 528781c1b3 Update composer.dingo.json 3 anni fa
composer.json 8f64a3c14f Merge remote-tracking branch 'origin/master' 3 anni fa
composer.lowest.json 4570c2aa9f Fix tests on lowest 3 anni fa
logo-scribe.png 908fd36b04 Update doc 5 anni fa
phpstan.neon 185b327dd8 Fix CI 2 anni fa
phpunit.xml 710dd8c711 Add failing test for underscore resource params 3 anni fa

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.