常见问题
此插件配置过于灵活, 以下均为示例, 需根据实际情况做合适的处理。
如何添加配置文件
如何组织 API 到指定模块、API 分组
module
用于分类 api
💡
怎么设置接口 API 所属文件夹的名称
.apifox-helper.properties
示例# read folder name from tag `folder`
folder.name=#folder
@folder
注释💡
如何增加外层的公共返回响应 Response 泛型
.apifox-helper.properties
示例# 假定 公共 ResponseDo 的包名为 com.xxx
method.return=groovy: "com.xxx.ResponseDo<" + it.returnType() +">"
💡
如何忽略 API
#ignore class or method which has comment tag 'ignore'
ignore=#ignore
如何设置 API/文件夹的名称/描述
如何在 API/文件夹的描述中说明 API/文件夹被废弃了
如何在 API 描述中声明 API 需要的权限(javax annotation security)
如何在 API 描述中声明 API 需要的权限(spring security)
如何忽略某些字段
json.rule.field.ignore
如何将指定类型转换为另一种类型处理
java.time.LocalDateTime
作为yyyy-mm-dd
形式字符串处理
java.time.LocalDateTime
作为timestamp
处理
部分接口可能有不同的返回
method.doc
将可能的返回放在方法备注中
有的字段可能有不同类型的值
field.doc
将可能的类型值放在字段备注中
如何适配 Mybatis Plus 工程的分页 Page 模型和请求参数?
>= 1.1.16
,然后可以通过项目内配置规则来实现适配识别。Page 模型 = com.baomidou.mybatisplus.extension.plugins.pagination.Page
,注意有些配置是可选的,根据自己的项目代码风格选择即可。method.return
配置,并增加注释 @response
如下图
current, size
参考来源 Github Issue,其他文章
如何开启 javax_validation 分组校验
javax.validation
, 勾选javax.validation(grouped)
如何激活对 com.fasterxml.jackson.annotation.JsonIgnoreProperties 的支持
Jackson_JsonIgnoreProperties
导出时出现 com.xxx.Xxx is to complex. Blocked cause by xxx reached xxx, 如何处理
导出时出现 No APIs be found to upload!, 如何处理
修改于 2025-01-07 07:30:21