自动生成apidoc接口文档_yml apidoc-CSDN博客

本文介绍了一种简化API文档编写的方法，通过修改代码生成工具，实现API文档的自动化生成，减轻开发人员的手动文档编写负担。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

开发过程中，个人认为编写接口文档是个很烦人的事，没有或者随便写，前端对接的时候不清楚就更烦人了。
使用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": ""
    *	  }
    */

干脆把平时常用的代码生成工具给改了一下
在这里插入图片描述
懒得自己改代码生成器可以用我这个

下载地址