Swagger UI将身份验证令牌传递到标头中的API调用

Question

我是Swagger的新手。

我使用Swagger UI来生成Swagger文档。我有两个API调用。第一个调用是基于用户名和密码生成令牌。第二次调用需要第一次调用生成的令牌。

我如何使用Swagger UI设置第二次调用的令牌？

Answer 1

另一种选择是添加全局操作参数。它将在每个终结点中添加一个用于授权的字段。

定义授权标头参数：

Parameter authHeader = new ParameterBuilder()
  .parameterType("header")
  .name("Authorization")
  .modelRef(new ModelRef("string"))
  .build();

将其添加到Docket配置：

return new Docket(DocumentationType.SWAGGER_2)
    .select()
    .apis(...)
    .paths(...)
    .build()
    .apiInfo(...)
    .globalOperationParameters(Collections.singletonList(authHeader));

Answer 2

我对2.9.2 Swagger版本的配置是在Swagger UI上添加授权并发送无记名令牌

java prettyprint-override">    @Configuration
    public class SwaggerConfiguration{

        //...

          @Bean
          public Docket api(ServletContext servletContext) {
            return new Docket(DocumentationType.SWAGGER_2)...
                .securitySchemes(Arrays.asList(apiKey()))
                .securityContexts(Collections.singletonList(securityContext()));
          }

          private SecurityContext securityContext() {
            return SecurityContext.builder().securityReferences(defaultAuth()).forPaths(PathSelectors.regex("/.*")).build();
          }

          private List<SecurityReference> defaultAuth() {
            final AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
            final AuthorizationScope[] authorizationScopes = new AuthorizationScope[]{authorizationScope};
            return Collections.singletonList(new SecurityReference("Bearer", authorizationScopes));
          }

          private ApiKey apiKey() {
            return new ApiKey("Bearer", "Authorization", "header");
          }
    } 

Answer 3

< code > @ apimplicitparams 和< code > @ apimplicitparam 应该可以解决这个问题:

@GET
@Produces("application/json")
@ApiImplicitParams({
    @ApiImplicitParam(name = "Authorization", value = "Authorization token", 
                      required = true, dataType = "string", paramType = "header") })
public String getUser(@PathParam("username") String userName) {
    ...
}

从文档中：

您可能希望手动描述操作参数。这可能是由于各种原因，例如：

• 使用不使用JAX-RS注释的servlet
• 希望在定义参数时隐藏该参数，并使用完全不同的定义覆盖该参数
• 描述过滤器或其他资源在到达JAX-RS实现之前使用的参数

Swagger UI将会更新，这样您就可以从那里发送令牌。不需要对HTML做任何修改。

_{注意：不久前，当使用Swagger记录REST API时，我意识到仅仅添加@ApiImplicitParam是不够的（即使你只有一个参数）。无论如何，您还必须添加@ApiImplicitParams。}