使用

文档生成

在 Controller/接口 中右键选择 Doc View。

其中包含以下操作选项：

在类中使用

在类中使用，则展示所有接口信息

在方法中使用

在方法内或者方法的注释内使用，则仅展示当前方法的接口信息

接口编辑

• 在预览界面点击编辑
• 在方法中右键菜单选择 Doc Editor
• 在实体类中右键选择 Doc Editor

编辑方法

通过面板对接口进行展示，可编辑信息如下：

1. 接口名称
2. 接口描述
3. 字段是否必填
4. 字段描述信息

编辑后结果如下：

/**
 * 接口描述信息
 *
 * @param reqVo reqVo
 * @return {@link ResultX<UserRespVo, UserAccount>}
 * @throws Exception
 * @DocView.Name 测试接口
 */

• 接口描述生成为注释信息
• 接口名称生成为 @DocView.Name 标签对应的信息
• 补全请求、返回、异常等注释 tag

防止代码侵入，@DocView.Name 命名也同时为了防止和原有字段名称冲突

编辑实体

@Data
public class UserAccount implements Serializable {

    /**
     * 用户 id
     */
    private String userId;

    /**
     * 别名
     */
    private String aliasName;

    private String merchantId;

    private String productCode;

}

已上面实体为例，Doc Editor 内容如下：

• 自动读取注释当做字段描述
• 读取是否存在必填，包括 Validated、Lombok、Swagger等注解、以及注释中是否存在 @DocView.Required tag。

以下为编辑结果，必填设置为 true 会自动填充 @DocView.Required 注释标签。

@Data
public class UserAccount implements Serializable {

    /**
     * 用户id
     *
     * @DocView.Required
     */
    private String userId;

    /**
     * 别名
     *
     * @DocView.Required
     */
    private String aliasName;

    /**
     * 商户号
     *
     * @DocView.Required
     */
    private String merchantId;

    /**
     * 产品号
     *
     * @DocView.Required
     */
    private String productCode;

}

上传

• 支持上传到 YApi
• 支持上传到 ShowDoc

上传会进行专门介绍，这里也欢迎小伙伴推荐其他文档平台