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

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

ИН на ревизия: 61e51d09a9
Клонове Маркери
scribe
ZIP TAR.GZ
shalvah 61e51d09a9 Fix crash when pagination not provided for transformer attribute преди 2 години
.github d2b152627e Merge branch 'master' into v4 преди 2 години
camel 78bcbe78e7 Merge branch 'master' into v4 преди 2 години
config 561dac8003 Refactor преди 2 години
resources 2da3dea1b2 Tests for response attributes преди 3 години
routes 060c41a565 Inline auto Laravel routes преди 3 години
src 61e51d09a9 Fix crash when pagination not provided for transformer attribute преди 2 години
tests 5be39d6d97 Lint преди 2 години
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files преди 3 години
.gitattributes c3a31009ba Support spatie/dto 3 преди 4 години
.gitignore ac9404ac12 Add tests for laravel type преди 3 години
.travis.yml c91eed5499 Update CI преди 4 години
CHANGELOG.md 78bcbe78e7 Merge branch 'master' into v4 преди 2 години
CONTRIBUTING.md 6457ea46f4 Add contribution guide преди 5 години
LICENSE.md 561dac8003 Refactor преди 2 години
README.md 561dac8003 Refactor преди 2 години
composer.dingo.json 23a6583667 Refactor преди 2 години
composer.json 23a6583667 Refactor преди 2 години
composer.lowest.json 3ea1bc647f Dingo and lowest deps преди 3 години
logo-scribe.png 908fd36b04 Update doc преди 5 години
phpstan.neon 5be39d6d97 Lint преди 2 години
phpunit.xml d582cc5dfb Refactor tests/add tests for laravel type преди 3 години

README.md

Scribe

Latest Stable Version Total Downloads


v4 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.

If you're coming from mpociot/laravel-apidoc-generator, first migrate to v3`, then to v4.

Contributing

Contributing is easy! See our contribution guide.