thinkphp5.0 自动生成api接口文档
时间: 2024-10-12 07:02:48 浏览: 33
ThinkPHP 5.0 提供了一种便捷的方式来自动化生成RESTful API接口文档,你可以使用官方推荐的DocBlock Comment(PHP注释)规范来描述接口和其参数。以下是如何操作:
1. **添加注释**:在每个控制器方法前,使用特殊的DocBlock Comment格式来描述接口信息。例如:
```php
/**
* @api {post} /users 添加用户
* @apiGroup 用户
* @apiParam {string} name 用户名
* @apiParam {string} password 密码
* @apiSuccessExample {json} 成功响应:
* HTTP/1.1 200 OK
* {
* "code": 200,
* "message": "成功",
* "data": {"id": 1}
* }
* @apiErrorExample 错误响应:
* HTTP/1.1 400 Bad Request
* {
* "code": 400,
* "message": "无效请求"
* }
*/
public function add()
```
2. **配置文档生成**:在`application/config/api.php`文件中,设置文档的相关路径和生成规则,例如标题、模板等。
3. **运行工具**:在命令行输入`think api:document` 来生成API文档,它通常会生成HTML文件到`doc`目录下。
4. **查看文档**:访问`http://your-site.com/doc` 查看生成的API文档。
阅读全文