温馨提示×

linux swagger如何权限控制

小樊
66
2026-09-24 22:19:35
栏目: 智能运维

在 Linux 环境下使用 Swagger(如 Swagger UI / Springfox / Knife4j / OpenAPI) 时,“权限控制”通常分为 几个层面,你可以根据场景选择:


一、最常见场景:Swagger UI 不能被所有人访问(生产环境禁用)

1️⃣ Spring Boot + Swagger(最典型)

✅ 开发环境开启,生产环境关闭

spring:
  profiles:
    active: dev

---
spring:
  config:
    activate:
      on-profile: dev
swagger:
  enabled: true

---
spring:
  config:
    activate:
      on-profile: prod
swagger:
  enabled: false
@Configuration
@ConditionalOnProperty(name = "swagger.enabled", havingValue = "true")
public class SwaggerConfig {
    // Swagger Bean
}

2️⃣ 使用 Spring Security 控制 Swagger 路径

@Override
protected void configure(HttpSecurity http) throws Exception {
    http
      .authorizeRequests()
      .antMatchers("/swagger-ui/**", "/v3/api-docs/**").authenticated()
      .anyRequest().permitAll()
      .and()
      .formLogin();
}

或生产环境完全拦截:

.antMatchers("/swagger-ui/**", "/v3/api-docs/**").denyAll()

二、基于角色的 Swagger 权限控制(RBAC)

场景:

  • 管理员可看 Swagger
  • 普通用户不可看
.antMatchers("/swagger-ui/**").hasRole("ADMIN")

三、接口级权限(接口是否暴露给 Swagger)

1️⃣ 隐藏某些接口

@ApiIgnore
@GetMapping("/internal")
public String internal() {
    return "secret";
}

或:

@Operation(hidden = true)

2️⃣ 按角色显示接口(Swagger 本身不强制)

⚠️ Swagger 只是“文档”,真正的权限必须在后端 Controller 做

@PreAuthorize("hasRole('ADMIN')")
@GetMapping("/admin")
public String adminApi() {
    return "admin";
}

四、Linux / Nginx 层权限控制(推荐生产用)

1️⃣ Nginx 限制 Swagger 访问

location /swagger-ui/ {
    allow 192.168.1.0/24;
    deny all;
    auth_basic "Swagger";
    auth_basic_user_file /etc/nginx/swagger.htpasswd;
}

生成密码:

htpasswd -c /etc/nginx/swagger.htpasswd admin

2️⃣ 防火墙 / 安全组

  • 只开放内网
  • 禁止公网 8080 / 443 的 /swagger-ui

五、Knife4j(增强 Swagger)权限

knife4j:
  enable: true
  basic:
    enable: true
    username: admin
    password: 123456

六、总结(推荐方案)

场景 推荐方式
生产禁用 profile 关闭
内网访问 Nginx + 密码
角色控制 Spring Security
接口隐藏 @ApiIgnore
真权限 Controller 层

如果你能告诉我:

  • 用的 Swagger 版本(2.x / 3.x / Knife4j)
  • 是否 Spring Boot
  • 是 开发还是生产环境

我可以直接给你一套可复制的配置。

0 踩