Accueil Explorer Aide
S'inscrire Connexion
wangjunyun
/
scribe
miroir de https://github.com/knuckleswtf/scribe.git
1
0
Fork 0
Fichiers Tickets 0 Wiki

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

Aborescence: b9f9fa328f
Branches Tags
scribe
ZIP TAR.GZ
shalvah b9f9fa328f PHP 8 + Laravel 8 minimum il y a 2 ans
.github b9f9fa328f PHP 8 + Laravel 8 minimum il y a 2 ans
camel cc6c95eed2 Support multiple docs il y a 3 ans
config 5fc7d25319 Update scribe.php il y a 3 ans
resources de5f746e7e hide pre tag instead code tag on switching the language il y a 2 ans
routes b859f9ac7d Fix Lumen routing for docs (fixes #365) il y a 3 ans
src b9f9fa328f PHP 8 + Laravel 8 minimum il y a 2 ans
tests 29940c2e05 Support more inline validator forms il y a 2 ans
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files il y a 3 ans
.gitattributes c3a31009ba Support spatie/dto 3 il y a 3 ans
.gitignore a81b4a86b9 Refactor tests il y a 5 ans
.travis.yml c91eed5499 Update CI il y a 3 ans
CHANGELOG.md 9e3d35d83d 3.32.0 il y a 2 ans
CONTRIBUTING.md 6457ea46f4 Add contribution guide il y a 5 ans
LICENSE.md d1a9a81509 3.2.0 il y a 3 ans
README.md 058559e9b2 Fix Ci il y a 3 ans
composer.dingo.json 528781c1b3 Update composer.dingo.json il y a 3 ans
composer.json b9f9fa328f PHP 8 + Laravel 8 minimum il y a 2 ans
composer.lowest.json 4570c2aa9f Fix tests on lowest il y a 3 ans
logo-scribe.png 908fd36b04 Update doc il y a 5 ans
phpstan.neon b9f9fa328f PHP 8 + Laravel 8 minimum il y a 2 ans
phpunit.xml 710dd8c711 Add failing test for underscore resource params il y a 3 ans

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.