Swagger Codigen CLIJava客户端-如何正确使用它

Question

我目前正在玩我的球衣Rest服务。为了更好地概述给定的服务（描述、类型等），我大量使用了swagger（swagger-jersey2-jaxrs）。因此，我能够生成我的服务描述（swagger.json），我可以通过swagger ui查看和探索它们。

现在我需要创建一些客户机来使用这些服务。我遇到了swagger codegen cli，它是一个很好的工具，可以生成您的客户端和许多不同的语言（在我的例子中是java）。我能够生成api客户端和正在使用的模型。

这里我面临第一个问题。REST服务和swagger描述受http基本身份验证保护。我阅读了一些文档，这些文档给了我一些提示，说明可以使用basicauth。在这一点上，我必须提到，从我的观点来看，文档非常糟糕。它说：

-，--auth在远程获取swagger定义时添加授权头。传入一个URL编码的字符串name:header，该字符串用逗号分隔多个值。

我首先想到的是传递一个类似于超文本传输协议头的字符串，但这并不起作用，甚至谷歌搜索如何使用基本身份验证和昂首阔步的cli也没有得到一些明确的答案。经过大量的尝试和错误，我（我使用CLI 2.1.2）终于遇到了正确的格式：

java-jar-swagger-codegen-cli-2.1.2。jar生成-a“授权：基本YWRtaW46YWRtaW4=“-ihttp://localhost:8080/webproject/restapi/swagger.json-l java-o restclient

其中YWRtaW46YWRtaW4=在我的例子中是admin:admin的base64编码值。

到现在为止，一直都还不错。生成的java客户端还必须使用基本身份验证。我查看了ApiClient中的方法，找到了setUsername和setPassword。我认为这种方法使客户端能够使用基本的auth，但没有运气。

因此，我深入研究了生成的类，特别是ApicClient和几个生成的ApisService类。我发现setUsername和setPassword无效，原因如下：

/**
   * Helper method to set username for the first HTTP basic authentication.
   */
  public void setUsername(String username) {
    for (Authentication auth : authentications.values()) {
      if (auth instanceof HttpBasicAuth) {
        ((HttpBasicAuth) auth).setUsername(username);
        return;
      }
    }
    throw new RuntimeException("No HTTP basic authentication configured!");
  }

其中同时HashMap定义如下：

// Setup authentications (key: authentication name, value: authentication).
authentications = new HashMap<String, Authentication>();
// Prevent the authentications from being modified.
authentications = Collections.unmodifiableMap(authentications);

身份验证哈希映射变得不可变，但为什么？目的何在？此外，ApiClinet中没有生成所需auth对象的辅助方法，因此我执行了以下操作：

1） 注释掉行身份验证集合。不可修改的映射（身份验证），因此哈希映射再次变得可修改

2）手动创建需要的auth对象

HttpBasicAuth authentication = new HttpBasicAuth(); 
authentication.setUsername("admin");
authentication.setPassword("admin");

3） 将auth对象添加到apiClients身份验证哈希映射：

ApiClient apiClient = new ApiClient();
apiClient.setBasePath(basePath);
apiClient.getAuthentications().put("basic", authentication);

4） 修改invokeApi方法（ApiClient.java）

public String invokeAPI(String path, String method, Map<String, String> queryParams, Object body, Map<String, String> headerParams, Map<String, String> formParams, String accept, String contentType, String[] authNames) throws ApiException {
String authNames2[] = {"basic"};
updateParamsForAuth(authNames2, queryParams, headerParams);
//updateParamsForAuth(authNames, queryParams, headerParams);
...

步骤4是必要的，因为ApiServices调用apiClient方法的方式如下：

String[] authNames = new String[] {  };
String response = apiClient.invokeAPI(path, "POST", queryParams, postBody, headerParams, formParams, accept, contentType, authNames);

另一种可能的解决方案是在每个API服务中定义authentications hashmap的密钥，如：

String[] authNames = new String[] { "basic" };

在做了所有的修改之后，一切都按照预期工作，但我认为这不是自动生成的rest客户机背后的想法。所以我的问题是：我是否遗漏了一些要点，或者我是否应该将swagger生成的客户机（在本例中为java）看作是一个正在开发的测试版解决方案？请正确地理解我，我认为整个swagger框架（jersey2支持、openapi、swaggerui、codegen）是一件很棒的事情，我感谢开发人员的努力，但我想正确地使用codegen，我不认为背后的想法是必须以这种方式定制生成的ApiClient和ApiServices。

Answer 1

如前所述，如果您不想修改现有代码，您可以在自定义配置中扩展ApiClient，例如。

@Configuration
public class Config {

  @Value("${baseUrl}")
  private String baseUrl;

  protected class AuthApiClient extends ApiClient {

    public AuthApiClient() {
      super();
    }

    @Override
    public <T> T invokeAPI(final String path, final HttpMethod method,
            final MultiValueMap<String, String> queryParams, final Object body,
            final HttpHeaders headerParams, final MultiValueMap<String, Object> formParams,
            final List<MediaType> accept, final MediaType contentType,
            final String[] authNames, final ParameterizedTypeReference<T> returnType)
            throws RestClientException {

            final HttpBasicAuth auth = new HttpBasicAuth();
            auth.setUsername("myUsername");
            auth.setPassword("myPassword");
            auth.applyToParams(queryParams, headerParams);

      return super.invokeAPI(path, method, queryParams, body, headerParams, formParams,
                accept, contentType, authNames, returnType);
    }
  }

  @Bean
  @Primary
  @Qualifier("MyApiClient")
  public AuthApiClient myApiClient() {
    final AuthApiClient apiClient = new AuthApiClient();
    apiClient.setBasePath(this.baseUrl);
    return apiClient;
  }
}

Answer 2

问题是您的规范没有提到要使用的安全类型（又名。安全定义）或哪个安全定义适用于哪个终端。

昂首阔步的规范在这里，但它并没有讲述整个故事。

你需要做的是1。设置安全性定义。下面是一个简单的基本http身份验证定义：

securityDefinitions:
  basic:
    type: basic
    description: HTTP Basic Authentication. 

二,。在endpoint中使用该安全性定义。

paths:
  /:
    get:
      security:
       - basic: []
      responses:
        200:
          description:  OK

然后重新生成你昂首阔步的客户端代码。它应该正确设置不可变映射和autNames数组。