Swagger2在Header中添加Token

本文介绍了如何使用Springfox在SpringMVC项目中配置Swagger接口文档,包括设置标题、描述、版本、联系信息以及添加headertoken参数。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

/**
 * Swagger接口文档
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig implements WebMvcConfigurer {

    @Bean
    public Docket createRestApi() {

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(true)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.fuint.module"))
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))//只生成被Api这个注解注解过的类接口
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))//只生成被ApiOperation这个注解注解过的api接口
                .build()
                .globalOperationParameters(setHeaderToken());
    }

    @Bean
    public ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口文档")
                .description("接口文档,“/clientApi”目录接口为会员端相关接口,“/backendApi”目录接口为后台管理端相关接口。")
                .termsOfServiceUrl("https://www.xx.com/")
                .contact(new Contact("东方信息技术有限公司", "https://www.xx.com/", "123@qq.com"))
                .version("1.0")
                .build();
    }

    /**
     * 添加header认证token
     *
     * @return
     */
    private List<Parameter> setHeaderToken() {
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        tokenPar.name("Access-Token").description("token").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());
        return pars;
    }
}
### 如何在Swagger添加和配置Token认证 #### ASP.NET Core Web API中的Swagger Token配置 对于ASP.NET Core的Web API项目,默认情况下,Swagger并未开启携带Token的功能。为了实现这一功能,在`Startup.cs`文件内的`ConfigureServices`方法中需要对SwaggerGen进行额外配置[^1]: ```csharp services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" }); // 添加安全定义 var securityScheme = new OpenApiSecurityScheme { Name = "Authorization", Type = SecuritySchemeType.ApiKey, In = ParameterLocation.Header, Scheme = "bearer", BearerFormat = "JWT" }; c.AddSecurityDefinition("Bearer", securityScheme); // 应用于所有APIs的安全需求 var securityRequirement = new OpenApiSecurityRequirement(); securityRequirement.Add(securityScheme, new[] {"readAccess", "writeAccess"}); c.AddSecurityRequirement(securityRequirement); }); ``` 上述代码片段展示了如何向Swagger文档注册一个名为“Bearer”的安全方案,并将其应用于所有的API端点。 #### Spring Boot项目的Swagger Token配置 针对Spring Boot项目而言,当存在权限认证机制时,为了让Swagger能够正常工作并发送带有认证信息的请求,同样也需要适当调整其配置方式。特别是从Swagger 2.x升级到3.0之后,配置过程有所变化[^2]: ```java @Bean public Docket api() { return new Docket(DocumentationType.OAS_30) .securitySchemes(Collections.singletonList(new ApiKey("Authorization", "Authorization", "header"))) .securityContexts(Arrays.asList(SecurityContext.builder() .securityReferences(defaultAuth()) .forPaths(PathSelectors.any()).build())) ; } private List<SecurityReference> defaultAuth() { AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything"); AuthorizationScope[] authorizationScopes = new AuthorizationScope[1]; authorizationScopes[0] = authorizationScope; return Collections.singletonList( new SecurityReference("Authorization", authorizationScopes)); } ``` 这段Java代码说明了怎样通过Docket对象来指定安全模式以及上下文环境,从而允许开发者利用Swagger界面手动输入或预先设定访问令牌。 完成以上任一框架下的相应修改后,重启应用程序即可看到效果。此时进入Swagger UI页面尝试调用任意接口之前,应该能看到一个新的参数项——`Authorization`被加入到了请求头部之中[^3]。用户可以在对应的文本框内填入形如`Bearer your_token_here`样式的字符串作为身份验证凭证,随后点击“Try it out!”按钮执行实际的操作请求。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值