首頁 探索 說明
註冊 登入
wangjunyun
/
scribe
镜像来自 https://github.com/knuckleswtf/scribe.git
1
0
複刻 0
Files 問題管理 0 Wiki

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

目錄樹: 5eb0f65973
分支列表 標籤列表
scribe
ZIP TAR.GZ
Shalvah 5eb0f65973 4.37.1 10 月之前
.github e41b0d75ea Adjust CI 1 年之前
camel 88b6c67c49 Allow examples to be shown in response fields (#825) 1 年之前
config b856570df1 Better tests + fixes for route rules vs strategy config 10 月之前
lang 7ad83bc02c Adjust indentation 1 年之前
resources 7f7b74a788 fix: fixes elements theme mutlipart form file upload (#864) 10 月之前
routes 92c128171c Final cleanups 2 年之前
src 5eb0f65973 4.37.1 10 月之前
tests 87c2dbd89a fix: multiple responses with the same status code (#863) 10 月之前
.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 年之前
CHANGELOG.md 5eb0f65973 4.37.1 10 月之前
CONTRIBUTING.md af8384feaf Update contribution guide link (#805) 1 年之前
Dockerfile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) 1 年之前
LICENSE.md 561dac8003 Refactor 2 年之前
Makefile 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) 1 年之前
README.md cb258f6e91 Update/fix migration URL in README. Remove errant backtick (#785) 1 年之前
composer.dingo.json 266326f05e Support php-parser v5 1 年之前
composer.json 138a47bed7 feat: Add Laravel 11 Support (#812) 1 年之前
composer.lowest.json 266326f05e Support php-parser v5 1 年之前
docker-compose.yml 9fca1f047f Add a `docker-compose` setup to allow project contributors to quickly run the test suite on their local machines. (#762) 1 年之前
logo-scribe.png 908fd36b04 Update doc 5 年之前
phpstan.neon 39f57d875b Fix lint 1 年之前
phpunit.xml 57b55ec1ce Support matching routes on method + path 1 年之前

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.