利用idea live template自动配置apidoc注解

最新推荐文章于 2023-11-18 18:55:46 发布

mei501501

最新推荐文章于 2023-11-18 18:55:46 发布

阅读量1.3k

点赞数 1

CC 4.0 BY-SA版权

分类专栏： idea插件 SpringBoot 自动化注解、API文档生成

本文链接：https://blog.youkuaiyun.com/mei501501/article/details/99772962

SpringBoot 同时被 3 个专栏收录

5 篇文章

订阅专栏

idea插件

1 篇文章

订阅专栏

自动化注解、API文档生成

1 篇文章

订阅专栏

本文介绍如何使用Apidoc及IDEA Live Template自动化生成RESTful API文档，提高开发效率。通过配置模板代码和动态参数，只需少量更改即可快速生成接口文档。

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

后端每次实现数据接口后都需要给前端写API接口文档，但是每次手写API文档很麻烦而且降低工作效率，利用Apidoc可以快速生成接口文档，懒癌患者解救双手，针对注解的规律利用利用idea live template自动配置apidoc注解，只需少量更改，懒惰是世界前进的动力.......

apidoc配置方法：

1、按照setting -> Editor -> Live Template -> add template group -> add live template:打开idea配置界面配置如下代码（抽象的模板代码）：

/**
   * @api {POST|GET} $methodName$ $methodName$
   * @apiName $methodName$
   * @apiGroup Users
   * @apiVersion 1.0.0
   * @apiDescription 接口描述
   *
   $param$
   * @apiParamExample {json} 请求样例：
   *                $url$
   *
   * @apiSuccess {Integer} code    状态码，0：请求成功
   * @apiSuccess {String} message   提示信息
   * @apiSuccess {Object} data    返回数据
   *
   * @apiSuccessExample {json} Success-Response:
   * {"code":0,"message":"","data":[]}
   *
   * @apiErrorExample {json} Error-Response:
   * {"code":5001,"message":"接口异常"}
   *
   */

2、编辑页面点击Edit variables编辑模板代码里面的动态参数：

$methodName$的代码(主要代码)如下:

methodName()

$param$的代码(主要代码)如下:

groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i<(params.size()-1)){result+=' * @apiParam {String} ' + params[i] + ' : ' + '\\n'}else{result+=' * @apiParam {String} ' + params[i] + ' : '}}; return result;}", methodParameters());

$url$的代码(主要代码)如下:

groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result='?'; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i<(params.size()-1)){result+=params[i] + '= ' + '&'}else{result+=params[i] + '= '}}; return result;}", methodParameters());

3、整体截图效果，保存配置：

4、在项目的配置文件加入apidoc.json配置文件配置如下信息：

{
  "name": "测试api文档",
  "version": "0.1.0",
  "description": "这只是一个测试的页面",
  "title": "APIDOC 测试",
  "url" : "http://127.0.0.1:8081/",
  "sampleUrl":"http://localhost:8081/"
}

5、在需要注解的类方法上输入live template的 doc快捷生成注释，修改完善后如下图

在整个项目外层执行apidoc命令生成restful api接口文档

apidoc -i /Users/mengqingmei/Documents/MyProject/ -o apidoc/

打开文档所在目录下的index.html查看生成的注解文档