swagger 兼容自定义注解JsonParam 正确显示请求参数【原创】

目前找不到相关的资料,只能自己debug进行修改

 
import cn.hutool.core.util.StrUtil;
import io.swagger.v3.core.util.RefUtils;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.Operation;
import io.swagger.v3.oas.models.media.*;
import io.swagger.v3.oas.models.parameters.Parameter;
import io.swagger.v3.oas.models.parameters.RequestBody;
import lombok.extern.slf4j.Slf4j;
import org.springdoc.core.customizers.GlobalOpenApiCustomizer;
import org.springframework.stereotype.Component;

/**
 * 重写swagger文档
 * 兼容JsonParam注解、@RequestBody注解时接收array类型参数
 * 显示正确的请求参数类型
 *
 */
@Slf4j
@Component
public class CustomerOperation implements GlobalOpenApiCustomizer {

    @Override
    public void customise(OpenAPI openApi) {
        // 遍历所有文档,将post请求且请求参数类型为query的参数转换为body请求体
        openApi.getPaths().forEach((k, v) -> {
            Operation operation = v.getPost();
            if (operation == null) {


                return;
            }
            if (operation.getParameters() != null) {
                if (operation.getRequestBody() == null || operation.getRequestBody().get$ref() == null) {
                    ObjectSchema objectSchema = new ObjectSchema();
                    for (Parameter parameter : operation.getParameters()) {
                        Schema schema = parameter.getSchema();
                        if (schema == null) {
                            schema = new StringSchema();
                            schema.name(parameter.getName());
                        }
                        schema.description(parameter.getDescription());
                        objectSchema.addProperty(parameter.getName(), schema);
                        if (parameter.getRequired() != null && parameter.getRequired()) {
                            objectSchema.addRequiredItem(parameter.getName());
                        }
                    }
                    // path+Dto 用于区分现有定义的DTO类(目前的DTO类都是大写的DTO),防止重复导致异常
                    String name = StrUtil.upperFirst(k.replaceAll("/", "").concat("Dto"));
                    openApi.getComponents().addSchemas(name, objectSchema);
                    // 只有使用$ref属性才能正常识别
                    RequestBody requestBody = new RequestBody().description("参数").content(new Content().addMediaType("application/json", new MediaType().schema(new ObjectSchema().$ref(RefUtils.constructRef(name)))));
                    operation.setRequestBody(requestBody);
                } else {
                    MediaType mediaType = operation.getRequestBody().getContent().get("application/json");
                    String type = mediaType.getSchema().getType();
                    Parameter parameter = operation.getParameters().get(0);
                    if ("array".equals(type)) {
                        mediaType.getSchema().name(parameter.getName()).getItems().type(parameter.getName());
                    }
                }
                operation.setParameters(null);
            }
        });
    }
}
  • 5
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger3中,可以通过自定义注解来进一步定制和扩展API文档的展示和功能。自定义注解允许开发者添加额外的信息,以便更好地描述和解释API接口。以下是Swagger3中常用的自定义注解: 1. @Api:用于描述整个Controller或接口的基本信息,包括接口的名称、描述等。 2. @ApiOperation:用于描述具体的API接口,包括接口的名称、描述、请求方法等。 3. @ApiParam:用于描述接口的参数,包括参数名称、描述、是否必须等信息。 4. @ApiModel:用于描述实体类或DTO的基本信息,包括类的名称、描述等。 5. @ApiModelProperty:用于描述实体类或DTO的属性,包括属性的名称、描述、示例值等。 通过使用这些自定义注解开发者可以清晰地定义和展示API接口的各种信息,方便其他开发人员理解和使用接口。同时,Swagger3还提供了丰富的UI界面,可以直观地展示接口的参数和返回结果,并提供接口测试的功能,类似于Postman工具。这样开发人员可以方便地测试和调试接口,提高开发效率。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* [Springboot整合Swagger3全注解配置(springdoc-openapi-ui)](https://blog.csdn.net/weixin_44768189/article/details/115055784)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *2* *3* [Swagger2注解的介绍](https://blog.csdn.net/weixin_33883178/article/details/92424879)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值