侧边栏壁纸
博主头像
孔子说JAVA博主等级

成功只是一只沦落在鸡窝里的鹰,成功永远属于自信且有毅力的人!

  • 累计撰写 352 篇文章
  • 累计创建 135 个标签
  • 累计收到 10 条评论

目 录CONTENT

文章目录

IDEA文档生成插件 Document Assistant 的安装配置与使用

孔子说JAVA
2022-11-10 / 0 评论 / 0 点赞 / 49 阅读 / 3,100 字 / 正在检测是否收录...
广告 广告

文档助手Document Assistant是基于基于IntelliJ IDEA开发的MarkDown文档生成插件,支持SpringMVC RestFul API。Document Assistant 可以直接分析带有@RestController的类代码,根据你选中的controller方法名称分析出参数、URI、注释等信息,并根据你的代码生成对应的文档,做到了真正的0侵入生成 RESTful api文档自动生成。

使用方式动图:

20190308163550851

1、安装方式

1.1 在线安装方式

第一种方式,是在IDEA上搜索插件进行安装,会适配当前IDEA的版本。打开File -> Settings 界面,在左侧列表中找到 Plugins 菜单,在右侧的 Marketplace 页签下,搜索 “Document”,可以找到 Document Assistant 插件,如下图所示,点击 Install 进行安装即可。

image-1667784156756

1.2 离线安装方式

第二种安装方式是使用离线插件进行安装。插件下载页面:https://plugins.jetbrains.com/idea ,在搜索框中输入插件名称 “Document” 搜索,点击出现的下拉提示,即可进入插件下载页面,选择对应安装版本下载即可。

下载完成后,进入插件市场,选择本地安装

同样是在 Settings 界面,在左侧列表中找到 Plugins 菜单,在右侧的 Installed 页签右方有个齿轮图标,点击展开菜单后选择 “Install Plugin from Disk…”,此时会打开本地文件选择框,选择你下载的插件包安装即可。

安装完成后重启IDEA。

2、插件的使用

文档助手Document Assistant是基于SpringMVC代码动态生成markdown文档的插件:

  • 通过动态分析项目应用配置文件以及注解配置生成其URI请求;
  • 通过SpringMVC的接口入口方法参数,分析入参的内容以及相关的注释生成入参表格以及请求JSON;
  • 通过SpringMVC的接口入口方法返回值,分析地址接口的出参内容以及注释生成出参表格以及回复的JSON;

注意

  • 控制器必须在类标识了@RestController;
  • 需要生成的接口方法,需要选择方法名,然后调用生成菜单(就是平时调用生成getter setter的菜单)点击生成文档视频;

使用步骤如下:1、选中需要生成的方法名称 2、调用生成菜单 3、copy 文档内容:

  1. 在SpringMVC中创建如下一个控制器类

这是一个非常普通的Spring RestController代码,需要注意的是:控制器类必须使用@RestController注解。

@RestController
@RequestMapping("/depositOrder")
public class DepositOrderController extends BaseController {
 
    @Autowired
    private DepositOrderService depositOrderService;
 
    /**
     * 充值订单记录搜索
     * @param req
     * @return
     */
    @PostMapping("/searchDepositOrder")
    public ResponseBasic<AppPage<DepositOrderSimpleVo>> searchDepositOrder(@RequestBody ReqSearchDepositOrder req){
        AppPage<DepositOrderSimpleVo> appPage = this.depositOrderService.searchDepositOrder(req);
        return ResponseBasic.ok(appPage);
    }
 
}
  1. 生成文档

选中方法名,这里选中"searchDepositOrder",然后按快捷键Alt+Insert,出现如下面板,选择"REST API Document generate"。

image-1667784710956

image-1667784776851

其生成方式是根据如下几点:

  • 接口名称生成:通过接口方法的JAVADOC注释 进行生成。

  • URI生成:通过application.yml 的 context-path 和 类的RestController类的RequestMapping 、方法的@PostMapping或者@GetMapping等等。

  • 请求参数生成:通过对象的或者方法参数动态生成请求参数列表,并且通过字段类型和字段JAVADOC注释自动生成请求参数。支持无线级别嵌套,同样自持父类字段的参数的生成,支持泛型。通过@NotNull annotation判断是否必要参数

  • 返回内容生成:通过返回的对象自动动态分析字段类型,字段注释等。支持无线级别嵌套,同样自持父类字段的参数的生成,支持泛型

  • 请求HTTP 方法:通过@PostMapping或者@GetMapping、@RequestMapping 配置获得是POST或者GET 等请求类型

  • 请求方式:通过是否为@RequestBody annotation获得相应信息进行生成。

生成的文档如下:

#  搜索充值方案
 
 
**请求URL:** 
- `/takeatorder/depositScheme/searchDepositScheme `
 
**请求方式:**
- POST
- RequestBody
 
 
###请求参数<业务参数>
 
|参数名|必选|类型|说明|
|:----    |:---|:----- |-----   |
|clientId|否|Long| 渠道号|
|status|否|Integer| 状态 0-待使用 1-使用中 2-已过期|
|denomination|否|Long| 面额|
|pageSize|否|Integer| 分页大小|
|pageNo|否|Integer| 页码|
 
###返回参数
 
|参数名|必选|类型|说明|
|:----    |:---|:----- |-----   |
|code|否|Integer| 返回的code码  1是正确|
|message|否|String| 服务端返回响应提示信息|
|data|否|Object| 服务端响应的实体|
|--content|否|List| content|
|----depositSchemeId|否|Long| 方案ID|
|----denomination|否|Long| 充值面额|
|----gift|否|Long| 赠送金额(元)|
|----clientName|否|String| 终端名称|
|----clientId|否|Long| 终端ID|
|----status|否|Integer| 状态 0-待使用 1-使用中 2-已过期 3-已禁用|
|----statusName|否|String| 状态名称|
|----adminUserName|否|String| 操作人名字|
|----adminUserId|否|Long| 操作人ID|
|----startTime|否|DateTime| 开始时间|
|----endTime|否|DateTime| 结束时间|
|----createTime|否|DateTime| 创建时间|
|----remark|否|String| 备注|
|--totalCount|否|Long|  总条目数|
|--currentPageNo|否|Long| 当前页码|
0

评论区