通过
搜索
搜索leandrodiogenes02 / scribe
从您的Laravel代码库生成面向人类的API文档。✍
3.19.3
2022-01-11 02:04 UTC
Requires
- php: >=7.4
- ext-fileinfo: *
- ext-json: *
- ext-pdo: *
- erusev/parsedown: ^1.7
- fakerphp/faker: ^1.9.1
- illuminate/console: ^6.0|^7.0|^8.0
- illuminate/routing: ^6.0|^7.0|^8.0
- illuminate/support: ^6.0|^7.0|^8.0
- league/flysystem: ^1.0
- mpociot/reflection-docblock: ^1.0.1
- nikic/php-parser: ^4.10
- nunomaduro/collision: ^3.0|^4.0|^5.0
- ramsey/uuid: ^3.8|^4.0
- shalvah/clara: ^3.0.2
- shalvah/upgrader: 0.*
- spatie/data-transfer-object: ^2.6|^3.0
- symfony/var-exporter: ^4.0|^5.0
- symfony/yaml: ^4.0|^5.0
Requires (Dev)
- brianium/paratest: ^6.0
- dms/phpunit-arraysubset-asserts: ^0.2.0
- laravel/legacy-factories: ^1.0.4
- laravel/lumen-framework: ^6.0|^7.0|^8.0
- league/fractal: ^0.19.0
- nikic/fast-route: ^1.3
- orchestra/testbench: ^4.0|^5.0|^6.0
- phpstan/phpstan: ^0.12.90
- phpunit/phpunit: ^9.0
- symfony/css-selector: ^5.3
- symfony/dom-crawler: ^5.3
Suggests
- league/fractal: Required for transformers support
Replaces
- dev-master
- 3.19.3
- 3.19.2
- 3.19.1
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.1
- 3.14.0
- 3.13.0
- 3.12.1
- 3.12.0
- 3.11.1
- 3.11.0
- 3.10.3
- 3.10.2
- 3.10.1
- 3.10.0
- 3.9.1
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.3
- 3.6.2
- 3.6.1
- 3.6.0
- 3.5.2
- 3.5.1
- 3.5.0
- 3.4.3
- 3.4.2
- 3.4.1
- 3.4.0
- 3.3.2
- 3.3.1
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.3
- 3.0.2
- 3.0.1
- 3.0.0
- v2.x-dev
- 2.7.10
- 2.7.9
- 2.7.8
- 2.7.7
- 2.7.6
- 2.7.5
- 2.7.4
- 2.7.3
- 2.7.2
- 2.7.1
- 2.7.0
- 2.6.0
- 2.5.3
- 2.5.2
- 2.5.1
- 2.4.2
- 2.4.1
- 2.4.0
- 2.3.0
- 2.2.1
- 2.2.0
- 2.1.0
- 2.0.3
- 2.0.2
- 2.0.1
- 2.0.0
- 2.0.0-beta.1
- 2.0.0-beta
- 2.0.0-alpha
- v1.x-dev
- 1.9.1
- 1.9.0
- 1.8.3
- 1.8.2
- 1.8.1
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.1
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.1
- 1.1.0
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- 1.0.0-beta4
- 1.0.0-beta3
- 1.0.0-beta2
- 1.0.0-beta
- dev-missing-headings
- dev-revert-354-feature/sidebar
- dev-collection
This package is not auto-updated.
Last update: 2024-09-29 10:51:43 UTC
README
Scribe帮助您从您的Laravel/Lumen/Dingo代码库生成面向人类的API文档。在demo.scribe.knuckles.wtf查看实时示例。还有一个Node.js版本！
特性
- 美观的单页HTML文档，包含人性化的文本、代码示例，并包含浏览器内API测试器（“试试”）
- 从FormRequests或验证规则中提取身体参数详情
- 安全调用API端点以获取示例响应
- 支持从Transformers或Eloquent API Resources生成响应
- 生成Postman集合和OpenAPI规范
- 易于使用自定义视图和内置UI组件进行自定义
- 易于通过自定义策略进行扩展
- 静态定义不在代码库中的额外端点
👋 Scribe可以帮助您自动生成文档，但如果您真的想创建友好、可维护和可测试的API文档，还有一些其他的事情您需要知道。所以我为您制作了一个课程。🤗
文档
请查看scribe.knuckles.wtf/laravel上的文档。
v2文档（PHP 7.2+，不再积极维护）在scribe.rtfd.io。
如果您来自mpociot/laravel-apidoc-generator，请查看迁移指南。
贡献
贡献很容易！请参阅我们的贡献指南。