Other Settings -> Doc View

image.png

接口生成信息

鼠标在字段悬停，会提示相关信息。

文档标题

文档标题是指 Doc View 界面左上角名称，也是类中所有接口所属的分类(上传接口在接口平台所属分类)，会按照指定的顺序获取。顺序如下：

为了防止名称为空，最后一项 DocView 不可取消勾选，其他可选择。

接口名称

接口名称指单个接口方法的名称，即上传文档时的文档名称，会按照指定顺序获取。顺序如下：

为了防止名称为空，最后一项 方法名 不可取消勾选，其他可选择。

可以看出这里是兼容 Swagger、Swagger 3 的，同时也支持使用注释标签或者方法注释，防止代码侵入。

接口描述

接口描述是生成文档中对接口的描述信息。

字段必填

字段必填，在接口文档中显示是否必填，兼容 Validation、Swagger、Swagger3、Lombok、注释标签。

其中除了 DocView 的注释标签可勾选之外，其他框架的注解一旦存在，则直接判断字段为必填字段。