通过 
搜索
搜索metafox / scribe
从您的Laravel代码库生成面向人类的API文档。✍
v4.22.1
2023-07-26 07:37 UTC
Requires
- php: >=8.0
- ext-fileinfo: *
- ext-json: *
- ext-pdo: *
- erusev/parsedown: 1.7.4
- fakerphp/faker: ^1.9.1
- illuminate/console: ^8.0|^9.0|^10.0
- illuminate/routing: ^8.0|^9.0|^10.0
- illuminate/support: ^8.0|^9.0|^10.0
- league/flysystem: ^1.1.4|^2.1.1|^3.0
- mpociot/reflection-docblock: ^1.0.1
- nikic/php-parser: ^4.10
- nunomaduro/collision: ^5.10|^6.0|^7.0
- ramsey/uuid: ^4.2.2
- shalvah/clara: ^3.1.0
- shalvah/upgrader: ^0.3.0
- spatie/data-transfer-object: ^2.6|^3.0
- symfony/var-exporter: ^5.4|^6.0
- symfony/yaml: ^5.4|^6.0
Requires (Dev)
- brianium/paratest: ^6.0
- dms/phpunit-arraysubset-asserts: ^0.4
- laravel/legacy-factories: ^1.3.0
- laravel/lumen-framework: ^8.0|^9.0|^10.0
- league/fractal: ^0.20
- nikic/fast-route: ^1.3
- orchestra/testbench: ^6.0|^7.0|^8.0
- pestphp/pest: ^1.21
- phpstan/phpstan: ^1.0
- phpunit/phpunit: ^9.0|^10.0
- symfony/css-selector: ^5.4|^6.0
- symfony/dom-crawler: ^5.4|^6.0
Replaces
- dev-master
- v4.22.1
- 3.26.0
- 3.25.0
- 3.24.1
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 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
This package is auto-updated.
Last update: 2024-09-26 05:39:54 UTC
README
v4已发布！功能包括子组、易于排序和自动升级命令。
Scribe帮助您从Laravel/Lumen/ Dingo 代码库生成面向人类的API文档。请查看demo.scribe.knuckles.wtf上的实时示例。
功能
- 有用的输出
- 漂亮的单页HTML文档，包含易于理解的文字、代码示例和浏览器中的API测试器（“试一试”）
- 生成Postman集合和OpenAPI规范
- 智能。Scribe可以做
- 从FormRequests或验证规则中提取请求参数细节
- 安全地调用API端点以获取示例响应
- 从Eloquent API资源或转换器生成示例响应
- 可自定义到不同级别
- 通过调整文本、排序、示例或更改UI本身来自定义UI
- 添加自定义策略以调整数据提取方式
- 静态定义额外的端点或不在代码库中的信息
👋 Scribe可以帮助您自动生成文档，但如果您真的想制作友好、可维护和可测试的API文档，还有一些其他事情您需要知道。所以我为您制作了一门课程。🤗
文档
请查看scribe.knuckles.wtf/laravel上的文档。
如果您来自mpociot/laravel-apidoc-generator，首先迁移到v3，然后迁移到v4。
贡献
贡献很容易！请参阅我们的贡献指南。