接口文档生成
编写好相关配置和文档注释后浏览器访问 即可查看相关文档,注意检查自己的监听端口和IP。
?> 接口文档地址只能在debug环境(cabal.debug
配置为true)下访问。
系统会自动根据你的路由配置,解析控制器方法的注释,自动生成生成,文档更新同样需要reload
或者服务器。
以下代码会生成一个像这样的文档。
- 模块名称 不能换行
- @apiIgnore 默认为不忽略,如果接口没有有注释但又不想展示文档时需要指定忽略该接口
- 请求参数
- @apiError 错误时候返回的字段
- 成功返回示例
- @apiErrorExample 错误返回示例