صفحهٔ اصلی گشت‌و‌گذار راهنما
ثبت نام ورود
wangjunyun
/
scribe
mirrorاز https://github.com/knuckleswtf/scribe.git
1
0
انشعاب 0
پرونده‌ها مشکلات 0 ویکی

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

درخت: 33c7a2e24b
شاخه‌ها تگ‌ها
scribe
ZIP TAR.GZ
Aleksander Penko 33c7a2e24b Remove unnecessary bracket in theme-default.style.css 2 سال پیش
.github 8711b5afb7 Issue template 2 سال پیش
camel 8a90c2d1ea Don't include status code in description (closes #561) 2 سال پیش
config 44996fe6f0 Support custom "Last updated at" label 2 سال پیش
resources 33c7a2e24b Remove unnecessary bracket in theme-default.style.css 2 سال پیش
routes 92c128171c Final cleanups 2 سال پیش
src c51adf3f82 4.6.1 2 سال پیش
tests 3cf6496039 ValidationRules: Refactor + use examples from parent for nested fields 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 c51adf3f82 4.6.1 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 e3092307da Fix bug in upgrader 2 سال پیش
composer.lowest.json 3ea1bc647f Dingo and lowest deps 2 سال پیش
logo-scribe.png 908fd36b04 Update doc 5 سال پیش
phpstan.neon 44996fe6f0 Support custom "Last updated at" label 2 سال پیش
phpunit.xml 67b77cb30b Exit with non-success code if there are warnings 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.