ホーム エクスプローラ ヘルプ
登録 サインイン
wangjunyun
/
scribe
同期ミラー https://github.com/knuckleswtf/scribe.git
1
0
フォーク 0
ファイル 課題 0 Wiki

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

ツリー: b4b190cd1f
ブランチ タグ
scribe
ZIP TAR.GZ
shalvah b4b190cd1f 4.21.2 1 年間 前
.github 8237b0df6a Create config.yml 1 年間 前
camel 8fe91d86e6 Expose default strategy for URL normalization 2 年 前
config 8183c296b5 Fix typo 2 年 前
lang 7ad83bc02c Adjust indentation 1 年間 前
resources 392b1094d7 Implement custom translation layer 1 年間 前
routes 92c128171c Final cleanups 2 年 前
src b4b190cd1f 4.21.2 1 年間 前
tests 963340f2be Only load custom translation layer on demand 1 年間 前
.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 b4b190cd1f 4.21.2 1 年間 前
CONTRIBUTING.md 6457ea46f4 Add contribution guide 5 年 前
LICENSE.md 561dac8003 Refactor 2 年 前
README.md 3328b3d2dd Readme 2 年 前
composer.dingo.json 23a6583667 Refactor 2 年 前
composer.json f0ed95653b API resources: Infer model name from @mixin 1 年間 前
composer.lowest.json 3ea1bc647f Dingo and lowest deps 2 年 前
logo-scribe.png 908fd36b04 Update doc 5 年 前
phpstan.neon 39f57d875b Fix lint 1 年間 前
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

  • Useful output:
    • Pretty single-page HTML doc, with human-friendly text, code samples, and in-browser API tester ("Try It Out")
    • Generates Postman collection and OpenAPI spec
  • Smarts. Scribe can:
    • extract request parameter details from FormRequests or validation rules
    • safely call API endpoints to get sample responses
    • generate sample responses from Eloquent API Resources or Transformers
  • Customisable to different levels:
    • Customise the UI by adjusting text, ordering, examples, or change the UI itself
    • Add custom strategies to adjust how data is extracted
    • Statically define extra endpoints or information that isn'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.