restio / laravel-api-doc-provider
基于 Laravel 框架的自动生成 API 文档的简单包
此包的官方仓库似乎已消失,因此该包已被冻结。
v2.0.2
2017-10-23 11:35 UTC
Requires
- php: >=5.4
- laravel/framework: 5.*
- zeptech/annotations: ^1.1
README
基于控制器注释的简单 API 文档生成器,适用于 Laravel 5.2.* | 5.3.*
按步骤安装
通过命令更新 composer
composer require restio/laravel-api-doc-provider
将服务提供者添加到 config/app.php
中的 providers
数组
RestioDocProvider\RestioDocProvider::class,
运行 artisan 命令
php artisan clear-compiled php artisan optimize
发布供应商
php artisan vendor:publish
配置
config/restio_doc.php
开始注释您的控制器(例如 app\Http\Controllers\ExampleController.php
)
关于注释
@route example_index
@description Example description for route
@required_params [token]
@optional_params [page]
- @route - 来自 RouteCollection 的路由名称
- @description - 关于此路由的简短描述(例如,主页,用户列表等)
- @required_params - 必需参数(此参数用红色五角星标记)
- @optional_params - 可选参数
- token, page - 在 app/Models/Doc.php 中的参数
编写单元测试,将成功响应写入 JSON 对象(例如 tests/RestioExampleTest.php
)
运行单元测试以生成成功响应
php phpunit
测试后,必须使用命令重新生成所有 API 文档
php artisan generate:docs
享受!