Java中如何不通过代码生成动态连接Swagger/OpenAPI端点？

前置场景 #

无需代码生成，基于已通过OpenAPIParser解析得到的OpenAPI对象发起调用，已有参考代码如下：

OpenAPI openAPI = new OpenAPIParser().readLocation(...).getOpenAPI();
String path = ...;
String method = "get";
Map<String, String> parameters = ...;

Operation operation = openAPI.getPath(path).readOperationsMap().get(method);

//What do I do next?!
WebTarget target = WhatGoesHere(path, parameters);
Response response = target.request()...;

手动实现核心逻辑 #

如果不需要额外引入工具，可按以下步骤直接处理：

• 第一步：获取基础服务地址，拼接得到完整请求路径模板
  从OpenAPI对象的servers配置中读取服务根地址，和传入的path拼接得到带占位符的完整路径：

  // 多Server场景可根据业务规则选择对应实例，此处默认取第一个
  String baseUrl = openAPI.getServers().get(0).getUrl();
  String pathTemplate = baseUrl + path;
  

• 第二步：替换路径参数
  遍历Operation的参数配置，识别路径参数，将路径模板中的占位符替换为实际参数值，同时移除已处理的参数避免重复计算：

  String processedPath = pathTemplate;
  Map<String, Object> remainingParams = new HashMap<>(parameters);
  for (Parameter param : operation.getParameters()) {
      if ("path".equals(param.getIn())) {
          String paramName = param.getName();
          if (remainingParams.containsKey(paramName)) {
              processedPath = processedPath.replace("{" + paramName + "}", 
                  remainingParams.remove(paramName).toString());
          }
      }
  }
  

• 第三步：初始化WebTarget并设置查询参数

  WebTarget target = ClientBuilder.newClient().target(processedPath);
  for (Parameter param : operation.getParameters()) {
      if ("query".equals(param.getIn()) && remainingParams.containsKey(param.getName())) {
          target = target.queryParam(param.getName(), remainingParams.remove(param.getName()));
      }
  }
  

• 第四步：构造请求对象，设置请求头、Cookie参数

  Invocation.Builder requestBuilder = target.request();
  for (Parameter param : operation.getParameters()) {
      if ("header".equals(param.getIn()) && remainingParams.containsKey(param.getName())) {
          requestBuilder = requestBuilder.header(param.getName(), remainingParams.remove(param.getName()));
      }
      if ("cookie".equals(param.getIn()) && remainingParams.containsKey(param.getName())) {
          requestBuilder = requestBuilder.cookie(param.getName(), remainingParams.remove(param.getName()).toString());
      }
  }
  

• 第五步：发起对应方法的请求，带请求体的方法需额外处理请求体序列化

  // GET请求示例
  Response response = requestBuilder.get();
  // POST请求示例
  // Response response = requestBuilder.post(Entity.json(requestBodyObj));
  

可用工具库 #

如果不想手动实现全量逻辑，可使用以下工具库直接实现动态调用能力：

• openapi-dynamic-client：专为OpenAPI动态调用设计的Java库，可直接传入解析好的OpenAPI对象、路径、方法和参数，直接返回响应结果，无需手动处理参数分类、序列化等逻辑。
• 如果使用Spring生态，可基于WebClient+SpringDoc封装动态调用能力，直接复用Spring已有的序列化、请求处理逻辑。

注意事项 #

• 需要按照OpenAPI定义的参数格式做类型转换，比如日期、枚举、数组类型的参数要符合规范要求
• 接口的认证逻辑需要从openAPI.getComponents().getSecuritySchemes()中读取配置，对应设置到请求的对应位置
• 多服务实例场景下不要默认取第一个Server，需要根据实际的环境规则选择对应的服务地址

内容的提问来源于stack exchange，提问作者Matthew