swagger-php如何编写集合数据的接口文档注释?
疑问
如题,最近开始研究swagger-php,文档和示例都翻了几遍,还是有点不太明白怎么定义definition,才能通过自由组合完成下方代码API文档的编写。疑问如下:
- 如果我分别定义部门模型和权限模型,那么在返回类似下面这样的数据的时候,怎么才能把权限模型嵌套进部门模型?
- 还是下面的数据,我希望将分页统一定义到一个definition中,这里该怎么引用?
返回的JSON数据如下:
{
"message": "OK",
"data": {
"current_page": 1,
"data": [
{
"id": 1,
"role_name": "管理员",
"status": 1,
"created_at": "2018-03-05 09:41:01",
"updated_at": "2018-03-05 09:41:01",
"permission": []
},
{
"id": 2,
"role_name": "技术部",
"status": 1,
"created_at": "2018-03-05 09:41:01",
"updated_at": "2018-03-05 09:41:01",
"permission": [
{
"id": 5,
"permission_name": "权限列表",
"pid": 0,
"api_url": "PermissionController@index",
"client_url": "/permission/index",
"created_at": "2018-03-05 09:41:01",
"updated_at": "2018-03-05 09:41:01"
}
]
}
],
"first_page_url": "http://t.xxx/api/role?page=1",
"from": 1,
"next_page_url": null,
"path": "http://t.xxx/api/role",
"per_page": 10,
"prev_page_url": null,
"to": 2
}
}
最后感谢各位大佬百忙之中回答我的提问 :-)
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论