开发过程中,个人认为编写接口文档是个很烦人的事,没有或者随便写,前端对接的时候不清楚就更烦人了。
使用aoidoc可以简化这个操作,可我有时候连apidoc的注释都懒得写
/**
* @api {get} /management/smHard/insert 新增
* @apiName insert
* @apiGroup 智能设备
* @apiVersion 0.1.0
* @apiDescription 新增单条
* @apiParam {Integer}
* @apiParam {Integer}
* @apiParam {String} hardwareName 硬件名称【必填】
* @apiParam {String} hardware
* @apiParam {Integer} hardwareType
* @apiParam {String} createUser 创建人
*
* @apiSuccessExample Success-Response:
* HTTP/1.1 200 OK
* {
* "code": 200,
* "msg": "SUCCESS",
* }
*
* @apiErrorExample {json} Error-Response:
* HTTP/1.1 404 Not Found
* {
* "resultCode": "999",
* "resultMsg": "操作失败,异常信息为:参数id不能为空",
* "data": ""
* }
*/
干脆把平时常用的代码生成工具给改了一下
懒得自己改代码生成器可以用我这个
下载地址
下载后 改下yml的配置文件就能直接用了 希望能有所帮助