Начало Каталог Помощ
Регистрация Вход
wangjunyun
/
scribe
огледало от https://github.com/knuckleswtf/scribe.git
1
0
Разклонения 0
Файлове Задачи 0 Уики

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

ИН на ревизия: 8f64a3c14f
Клонове Маркери
scribe
ZIP TAR.GZ
shalvah 8f64a3c14f Merge remote-tracking branch 'origin/master' преди 3 години
.github 1031b1d72f Update deps for Laravel 9 (#405) преди 3 години
camel 1031b1d72f Update deps for Laravel 9 (#405) преди 3 години
config 25cbdc193f Add prerequest hook преди 3 години
resources 96e319db95 Fix bug where toggling the menu on mobile would jump to the top of the page преди 3 години
routes b859f9ac7d Fix Lumen routing for docs (fixes #365) преди 3 години
src f4e89ae0ee Switch to Pest test runner, improve coverage преди 3 години
tests f4e89ae0ee Switch to Pest test runner, improve coverage преди 3 години
.editorconfig 24d3f6aa22 Add some dotfiles преди 9 години
.gitattributes c3a31009ba Support spatie/dto 3 преди 3 години
.gitignore a81b4a86b9 Refactor tests преди 5 години
.travis.yml c91eed5499 Update CI преди 3 години
CHANGELOG.md 615754c9a9 3.21.0 преди 3 години
CONTRIBUTING.md 6457ea46f4 Add contribution guide преди 5 години
LICENSE.md d1a9a81509 3.2.0 преди 3 години
README.md 058559e9b2 Fix Ci преди 3 години
composer.dingo.json 528781c1b3 Update composer.dingo.json преди 3 години
composer.json 8f64a3c14f Merge remote-tracking branch 'origin/master' преди 3 години
composer.lowest.json 769fedbb3a Fix CI преди 3 години
logo-scribe.png 908fd36b04 Update doc преди 5 години
phpstan.neon 1031b1d72f Update deps for Laravel 9 (#405) преди 3 години
phpunit.xml f4e89ae0ee Switch to Pest test runner, improve coverage преди 3 години

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.