框架支持

基于性能考虑, 内置推荐配置并不会覆盖所有框架的所有功能

如需增加对指定框架的支持, 参考配置

Spring Boot

在推荐配置中有很多 spring-boot 相关的配置

处理HttpEntity/RequestEntity/ResponseEntity

加载 spring-boot 相关配置:

默认使用 spring-boot 配置中的server.servlet.context-path

Spring Boot Webflux

在推荐配置中有部分 springboot-webflux 相关的配置

Swagger

默认推荐配置中不包含swagger的支持

如果需要支持 swagger,可自行按需增加如下配置

基础配置

快速配置

增强配置

可根据实际情况修改

快速配置

JAX-RS

插件支持JAX-RS协议

quarkus

jersey

确认勾选:Preferences(Settings) > Other Settings > EasyApi > Support > jaxrs(quarkus | jersey)

quarkus & jersey

javax.validation

在推荐配置中有部分 javax.validation 相关的简单配置

简单-不分组

默认选择的就是不分组模式javax.validation

可以在 Preferences(Settings) > Other Settings > EasyApi >Recommend 中检查是否有勾选javax.validation, 并移除勾选javax.validation(grouped)

简单-分组

默认选择的是不分组模式javax.validation

简单分组可以在 Preferences(Settings) > Other Settings > ApiFoxHelper 下面配置

Recommend > (取消勾选)javax.validation

Recommend > (取消勾选)support_mock_for_javax_validation

Recommend > (勾选)javax.validation(grouped)

RemoteConfig > (取消勾选) https://cdn.apifox.com/ide-plugin/idea/apifox-helper/setting/javax.validation.config

RemoteConfig > (勾选) https://cdn.apifox.com/ide-plugin/idea/apifox-helper/setting/javax.validation-group.config

完全-不分组

需要对javax.validation完整的支持, 可自行增加如下配置

上述配置可根据实际情况予以必要的调整

key	desc
number_min	数字最小值
number_max	数字最大值
float_dmin	浮点数小数位数

快速配置

或者

完全-分组

Jackson

JsonProperty&JsonIgnore

推荐配置中默认支持。

JsonIgnoreProperties

推荐配置中有提供选项, 但默认未选中.

Dubbo

如果仅希望导出markdown

参照导出普通 java method 文档即可

如果希望导出到Apifox

参照自定义框架

取消勾选 Preferences(Settings) > Other Settings > Apifox Helper > Support > methodDoc

勾选 Preferences(Settings) > Other Settings > Apifox Helper > Support > generic export

在 Preferences(Settings) > Other Settings > Apifox Helper > BuiltinConfig 或者本地文件引入配置:

properties.additional=https://cdn.apifox.com/ide-plugin/idea/apifox-helper/setting/dubbo.config

如果配置不满足预期, 复制并修改 dubbo.config 的内容放在配置里, 替换掉上面的引入配置

Spring Boot#

Spring Boot Webflux#

Swagger#

基础配置#

增强配置#

JAX-RS#

quarkus & jersey#

javax.validation#

简单-不分组#

简单-分组#

完全-不分组#

完全-分组#

Jackson#

JsonProperty&JsonIgnore#

JsonIgnoreProperties#

Dubbo#

Spring Boot

Spring Boot Webflux

Swagger

基础配置

增强配置

JAX-RS

quarkus & jersey

javax.validation

简单-不分组

简单-分组

完全-不分组

完全-分组

Jackson

JsonProperty&JsonIgnore

JsonIgnoreProperties

Dubbo