在 Linux 环境下使用 Swagger(如 Swagger UI / Springfox / Knife4j / OpenAPI) 时,“权限控制”通常分为 几个层面,你可以根据场景选择:
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
}
@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()
.antMatchers("/swagger-ui/**").hasRole("ADMIN")
@ApiIgnore
@GetMapping("/internal")
public String internal() {
return "secret";
}
或:
@Operation(hidden = true)
⚠️ Swagger 只是“文档”,真正的权限必须在后端 Controller 做
@PreAuthorize("hasRole('ADMIN')")
@GetMapping("/admin")
public String adminApi() {
return "admin";
}
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
/swagger-uiknife4j:
enable: true
basic:
enable: true
username: admin
password: 123456
| 场景 | 推荐方式 |
|---|---|
| 生产禁用 | profile 关闭 |
| 内网访问 | Nginx + 密码 |
| 角色控制 | Spring Security |
| 接口隐藏 | @ApiIgnore |
| 真权限 | Controller 层 |
如果你能告诉我:
我可以直接给你一套可复制的配置。