autaut03 / laravel-api-docs-generator
此包已被废弃,不再维护。未建议替代包。
从您的 Laravel 应用程序生成美观的 API 文档
dev-master
2018-08-24 18:59 UTC
Requires
- php: >=7.1.3
- laravel/framework: 5.6.*
- mpociot/reflection-docblock: ^1.0
- ramsey/uuid: ^3.0
Requires (Dev)
- mockery/mockery: ^0.9.5
- orchestra/testbench: ~3.0
- phpunit/phpunit: ~7.0
This package is auto-updated.
Last update: 2021-11-28 23:49:11 UTC
README
BETA 版本
目前尚无 HTML 生成功能。
自动从现有的 Laravel 路由生成 API 文档。目前尚无示例。
安装
使用以下命令通过 composer 安装此包:
$ composer require autaut03/laravel-api-docs-generator
使用 Laravel < 5.5?请前往您的 config/app.php
并添加服务提供者
AlexWells\ApiDocsGenerator\PackageServiceProvider::class,
发布供应商
如果您想修改 HTML 模板或对资产(图片、CSS、JS)进行一些更改,则发布供应商文件
$ php artisan vendor:publish
之后,视图和资产将出现在 resources/vendor/api-docs
目录中,并将替换默认内容。
用法
要生成您的 API 文档,请使用 api-docs:generate
artisan 命令。
$ php artisan api-docs:generate -m="api/v2/*" -m="non-api/another" -m="manual/{p}"
使用 -h 标志以获取可用选项列表
它是如何工作的?
此包使用以下资源生成 API 文档