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

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

ИН на ревизия: bb2f6c5c51
Клонове Маркери
scribe
ZIP TAR.GZ
shalvah bb2f6c5c51 Merge remote-tracking branch 'origin/master' преди 2 години
.github 898278ddd2 Update CI преди 2 години
camel 8fe91d86e6 Expose default strategy for URL normalization преди 2 години
config 44996fe6f0 Support custom "Last updated at" label преди 2 години
resources fcbe079674 Clean up преди 2 години
routes 92c128171c Final cleanups преди 2 години
src 617e110f68 Ignore examples.models_source преди 2 години
tests 05b192c5a2 Fix tests преди 2 години
.editorconfig c897db868e fix(.editorconfig): added formatter for .json files преди 3 години
.gitattributes c3a31009ba Support spatie/dto 3 преди 3 години
.gitignore ac9404ac12 Add tests for laravel type преди 2 години
.travis.yml c91eed5499 Update CI преди 3 години
CHANGELOG.md 1df972a3f7 4.16.0 преди 2 години
CONTRIBUTING.md 6457ea46f4 Add contribution guide преди 5 години
LICENSE.md 561dac8003 Refactor преди 2 години
README.md 6c17082f2b - преди 2 години
composer.dingo.json 23a6583667 Refactor преди 2 години
composer.json a431639965 Fix Laravel 10 compatibility преди 2 години
composer.lowest.json 3ea1bc647f Dingo and lowest deps преди 2 години
logo-scribe.png 908fd36b04 Update doc преди 5 години
phpstan.neon 9a02fdb91b Fix build преди 2 години
phpunit.xml ecfd1a18e5 Fix nested filters when generating examples for PHP, JS and Python преди 2 години

README.md

Scribe

Latest Stable Version Total Downloads


v4 is out now! Featuring subgroups, easier sorting, and an automated upgrade command.

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.