Skip to content

Commit 6d1a315

Browse files
authored
chore: add security configuration into swagger (#21)
Co-authored-by: rick <LinuxSuRen@users.noreply.github.com>
1 parent e3992c6 commit 6d1a315

3 files changed

Lines changed: 28 additions & 7 deletions

File tree

pom.xml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,6 @@
4747
<version>1.1.0</version>
4848
</dependency>
4949

50-
<dependency>
51-
<groupId>org.springdoc</groupId>
52-
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
53-
<version>2.2.0</version>
54-
</dependency>
55-
5650
<dependency>
5751
<groupId>org.springframework.boot</groupId>
5852
<artifactId>spring-boot-starter-test</artifactId>
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
package io.github.devopsws.demo.config;
2+
3+
import org.springframework.context.annotation.Configuration;
4+
5+
import io.swagger.v3.oas.annotations.ExternalDocumentation;
6+
import io.swagger.v3.oas.annotations.OpenAPIDefinition;
7+
import io.swagger.v3.oas.annotations.enums.SecuritySchemeIn;
8+
import io.swagger.v3.oas.annotations.enums.SecuritySchemeType;
9+
import io.swagger.v3.oas.annotations.info.Info;
10+
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
11+
import io.swagger.v3.oas.annotations.security.SecurityScheme;
12+
13+
@OpenAPIDefinition(info = @Info(title = "Demo Project for API Testing"),
14+
externalDocs = @ExternalDocumentation(
15+
description = "Read more from the offical document.",
16+
url = "https://linuxsuren.github.io/api-testing/"
17+
),
18+
security = {
19+
@SecurityRequirement(name = "basicAuth")
20+
})
21+
@Configuration
22+
@SecurityScheme(
23+
type = SecuritySchemeType.HTTP,
24+
in = SecuritySchemeIn.HEADER,
25+
name = "basicAuth",
26+
scheme = "basic")
27+
public class SpringdocConfig {}

src/main/java/io/github/devopsws/demo/config/WebSecurityConfig.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public class WebSecurityConfig {
2121
@Bean
2222
public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
2323
http.authorizeHttpRequests((requests) -> requests
24-
.requestMatchers("/health", "/v3/api-docs", "/graphql", "/graphiql").permitAll()
24+
.requestMatchers("/health", "/v3/api-docs/**", "/swagger-ui/*", "/graphql", "/graphiql").permitAll()
2525
.anyRequest().authenticated())
2626
.httpBasic(withDefaults())
2727
.csrf(AbstractHttpConfigurer::disable);

0 commit comments

Comments
 (0)