常见问题 FAQ
常见问题 FAQ
如何添加配置文件
如何组织API到指定文件夹
module用于分类api#find module from comment tag
module=#module如何忽略API
#ignore class or method which has comment tag 'ignore'
ignore=#ignore如何设置API/文件夹的名称/描述
如何在API/文件夹的描述中说明API/文件夹被废弃了
method.doc[#deprecated]=groovy:"\n「deprecated」" + it.doc("deprecated")
method.doc[@java.lang.Deprecated]=「deprecated」
method.doc[@kotlin.Deprecated]=groovy:"\n「deprecated」" + it.ann("kotlin.Deprecated","message")
method.doc[groovy:it.containingClass().hasDoc("deprecated")]=groovy:"\n「deprecated」" + it.containingClass().doc("deprecated")
method.doc[groovy:it.containingClass().hasAnn("java.lang.Deprecated")]=「deprecated」
method.doc[groovy:it.containingClass().hasAnn("kotlin.Deprecated")]=groovy:"\n「deprecated」 " + it.containingClass().ann("kotlin.Deprecated","message")
如何在API描述中声明API需要的权限(javax annotation security)
## security description
method.doc[@javax.annotation.security.RolesAllowed]=groovy:"require role:"+it.ann("javax.annotation.security.RolesAllowed")如何在API描述中声明API需要的权限(spring security)
## security description
doc.method[@org.springframework.security.access.prepost.PreAuthorize]=groovy:```
def preAuthorize = it.ann("org.springframework.security.access.prepost.PreAuthorize")
if(tool.nullOrBlank(preAuthorize)){
return
}
def role = regex.getGroup1("hasRole\\('(.*?)'\\)",preAuthorize)
return "require role: $role"
```如何忽略某些字段
## ignore field 'log'
json.rule.field.ignore=log## ignore field 'log' typed xxx.xxx.Log
json.rule.field.ignore=groovy:it.type().name()=="xxx.xxx.Log"#ignore transient field
json.rule.field.ignore=groovy:it.hasModifier("transient")如何将指定类型转换为另一种类型处理
java.time.LocalDateTime作为yyyy-mm-dd形式字符串处理#Resolve 'java.time.LocalDateTime' as 'java.lang.String'
json.rule.convert[java.time.LocalDateTime]=java.lang.String
json.rule.convert[java.time.LocalDate]=java.lang.Stringjava.time.LocalDateTime作为timestamp处理#Resolve 'java.time.LocalDateTime' as 'java.lang.Long'
json.rule.convert[java.time.LocalDateTime]=java.lang.Long
json.rule.convert[java.time.LocalDate]=java.lang.Long部分接口可能有不同的返回
method.doc[#result]=groovy: it.docs("result").collect{helper.resolveLink(it)}.grep{it!=null}.collect{"可能的返回:\n\n```json\n"+it.toJson(true)+"\n```\n\n"}.join("\n") /**
* @result {@link UserInfo}
* @result {@link Result<UserInfo>}
*/
public Result mockString() {
...
}有的字段可能有不同类型的值
field.doc[#maybe]=groovy:it.docs("maybe").collect{helper.resolveLink(it)}.collect{"可能是:\n\n```json\n" + it.toJson(true) +"\n```\n\n"}.join("\n") /**
* @maybe {@link UserInfo}
* @maybe {@link java.lang.String}
*/
public Object target;如何开启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, 如何处理
# ignore field with type com.xxx.Xxx
field.ignore=groovy:it.type().name()=="com.xxx.Xxx"max.deep=8
max.elements=512