### 如何在
Swagger 文档中全局配置默认请求头
为了在全球范围内为所有 API 接口
添加自定义的请求头，可以基于不同的编程语言和框架采取相应的解决方案。以下是针对 ASP
.NET Core 和 Java SpringFox 的具体方法。
#### 1
. **ASP
.NET Core 配置**
在 ASP
.NET Core 中可以通过 `OperationFilter` 来实现全局
添加请求头的功能。通过扩展 `IOperationFilter` 并将其注册到
Swagger 配置中，可以在每个操作上自动注入指定的 Header 参数。
```csharp
public class AddRequiredHeaderParameter : IOperationFilter
{
public void Apply(OpenApiOperation operation, OperationFilterContext context)
{
if (operation
.Parameters == null)
operation
.Parameters = new List<OpenApiParameter>();
operation
.Parameters
.Add(new OpenApiParameter
{
Name = "Authorization",
In = ParameterLocation
.Header,
Description = "Bearer token to access the APIs",
Required = true,
Schema = new OpenApiSchema
{
Type = "string"
}
});
}
}
```
随后，在启动服务时将此过滤器应用到
Swagger：
```csharp
services
.Add
SwaggerGen(c =>
{
c
.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
c
.OperationFilter<AddRequiredHeaderParameter>(); // 注册自定义过滤器
});
```
上述代码会确保所有 API 操作都会带有名为 `Authorization` 的头部字段[^1]。
---
#### 2
. **SpringFox（Java）中的配置**
对于使用 SpringFox 的项目，可以通过创建一个 Bean 实现 `OperationBuilderPlugin` 或者直接利用现有的插件机制来完成同样的功能。
下面是一个简单的例子展示如何向每一个接口
添加固定的 Header 请求参数：
```java
import springfox
.documentation
.spi
.DocumentationType;
import springfox
.documentation
.spring
.web
.plugins
.Docket;
import springfox
.documentation
.swagger.common西斯
.Xxx;
// 导入必要的包
...
@Component
public class CustomGlobalHeader implements Plugin {
@Override
public boolean supports(DocumentationType delimiter) {
return DocumentationType
.SWAGGER_2
.equals(delimiter);
}
@Override
public void apply(OperationContext context) {
context
.operationBuilder()
.parameters(
Arrays
.asList(
new ParameterBuilder()
.name("X-Custom-Token") // 自定义名称
.description("Custom Token for Authentication")
.modelRef(new ModelRef("string"))
.parameterType("header")
.required(true)
.build())
);
}
}
@Bean
public Docket apiDocumentation(CustomGlobalHeader customGlobalHeader){
return new Docket(DocumentationType
.SWAGGER_2)
.globalOperationParameters(customGlobalHeader
.apply(null))
...其他配置
...
}
```
这段代码片段展示了如何构建并注册一个新的全局 Header 参数给所有的 API 路径[^2]。
---
#### 3
. **Knife4j 生产环境下隐藏
文档资源**
如果希望进一步控制不同运行环境中是否暴露这些敏感信息，则推荐使用 Knife4j 提供的相关特性。只需简单调整 YAML 文件即可轻松切换开发与生产的模式设置而无需额外编写逻辑代码处理环境差异问题。
例如，在生产环境中完全禁用掉对外可见的部分内容可通过如下方式快速达成目标:
```yaml
server:
port: 8080
spring:
profiles: prod # 设置当前激活的是prod文件夹下的application-prod
.yml或者其他形式加载特定profile的方式均可生效。
knife4j:
enable: false # 关闭增强UI界面效果等功能模块开关，默认true开启状态；此处设false即关闭整个前端美化样式呈现部分。
production: true # 启用生产模式下的一些特殊行为比如隐藏某些按钮链接之类的交互细节表现优化措施等。
```
当设置了以上属性之后，即使访问地址正确也无法查看任何关于API描述方面的资料了[^3]。
---
### 总结
无论是哪种技术栈都可以找到合适的方法去满足业务需求——既能在测试阶段方便调试又能保障正式上线后的安全性考虑周全。关键是理解各自工具链的工作原理以及灵活运用它们所提供的强大定制能力！
最低0.47元/天 解锁文章
扫一扫
7405
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
