Обновление mock конфигурации для oauth2

Добавил пример с Oauth2
Добавил ApiResponse
2024-11-04 10:36:59 +03:00 · 2024-11-04 10:24:20 +03:00 · 2024-11-04 10:06:39 +03:00 · 2024-11-04 09:51:35 +03:00 · 2024-11-04 09:13:36 +03:00 · 2024-11-04 08:45:00 +03:00
9 changed files with 142 additions and 48 deletions
--- a/pom.xml
+++ b/pom.xml
@ -2,20 +2,23 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
+    <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-parent -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
-        <version>2.4.1</version>
+        <version>3.3.5</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
+
    <groupId>org.sadtech.example</groupId>
    <artifactId>swagger</artifactId>
    <version>0.0.1-SNAPSHOT</version>
+
    <name>swagger</name>
    <description>Demo project for Swagger</description>

    <properties>
-        <java.version>1.8</java.version>
+        <java.version>21</java.version>
    </properties>

    <dependencies>
@ -23,16 +26,16 @@
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
-
        <dependency>
-            <groupId>io.swagger.core.v3</groupId>
-            <artifactId>swagger-annotations</artifactId>
-            <version>2.1.6</version>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-oauth2-client</artifactId>
        </dependency>
+
+        <!-- https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-starter-webmvc-ui -->
        <dependency>
            <groupId>org.springdoc</groupId>
-            <artifactId>springdoc-openapi-ui</artifactId>
-            <version>1.5.2</version>
+            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+            <version>2.6.0</version>
        </dependency>
    </dependencies>

@ -45,4 +48,13 @@
        </plugins>
    </build>

+    <developers>
+        <developer>
+            <id>uPagge</id>
+            <name>Struchkov Mark</name>
+            <email>mark@struchkov.dev</email>
+            <url>https://mark.struchkov.dev</url>
+        </developer>
+    </developers>
+
 </project>
--- a/src/main/java/org/sadtech/example/swagger/config/OpenApiConfig.java
+++ b/src/main/java/org/sadtech/example/swagger/config/OpenApiConfig.java
@ -0,0 +1,44 @@
+package org.sadtech.example.swagger.config;
+
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
+import io.swagger.v3.oas.annotations.enums.SecuritySchemeIn;
+import io.swagger.v3.oas.annotations.enums.SecuritySchemeType;
+import io.swagger.v3.oas.annotations.info.Contact;
+import io.swagger.v3.oas.annotations.info.Info;
+import io.swagger.v3.oas.annotations.security.SecurityScheme;
+
+/**
+ * @author upagge 30.12.2020
+ */
+@OpenAPIDefinition(
+        info = @Info(
+                title = "Loyalty System Api",
+                description = "Loyalty System", version = "1.0.0",
+                contact = @Contact(
+                        name = "Struchkov Mark",
+                        email = "mark@struchkov.dev",
+                        url = "https://mark.struchkov.dev"
+                )
+        )
+)
+//@SecurityScheme(
+//        name = "Oauth2",
+//        type = SecuritySchemeType.OAUTH2,
+//        flows = @OAuthFlows(
+//                authorizationCode = @OAuthFlow(
+//                        tokenUrl = "https://oauth.mocklab.io/oauth/token",
+//                        refreshUrl = "https://oauth.mocklab.io/oauth/token",
+//                        authorizationUrl = "https://oauth.mocklab.io/oauth/authorize",
+//                        scopes = {@OAuthScope(name = "profile"), @OAuthScope(name = "email")}
+//                )
+//        )
+//)
+@SecurityScheme(
+        name = "jsessionid",
+        in = SecuritySchemeIn.COOKIE,
+        type = SecuritySchemeType.APIKEY,
+        paramName = "JSESSIONID"
+)
+public class OpenApiConfig {
+
+}
--- a/src/main/java/org/sadtech/example/swagger/config/SecurityConfig.java
+++ b/src/main/java/org/sadtech/example/swagger/config/SecurityConfig.java
@ -0,0 +1,28 @@
+package org.sadtech.example.swagger.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.security.config.annotation.web.builders.HttpSecurity;
+import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
+import org.springframework.security.web.SecurityFilterChain;
+
+@Configuration
+@EnableWebSecurity
+public class SecurityConfig {
+
+    @Bean
+    public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
+        return http
+                .cors().disable()
+                .oauth2Login()
+                .and()
+                .authorizeHttpRequests(
+                        registry -> registry
+                                .requestMatchers("/v3/api-docs/**", "/swagger-ui/**", "/swagger-ui.html")
+                                .permitAll()
+                                .anyRequest().authenticated()
+                )
+                .build();
+    }
+
+}
--- a/src/main/java/org/sadtech/example/swagger/config/SwaggerConfig.java
+++ b/src/main/java/org/sadtech/example/swagger/config/SwaggerConfig.java
@ -1,31 +0,0 @@
-package org.sadtech.example.swagger.config;
-
-import io.swagger.v3.oas.models.OpenAPI;
-import io.swagger.v3.oas.models.info.Contact;
-import io.swagger.v3.oas.models.info.Info;
-import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.Configuration;
-
-/**
- * @author upagge 30.12.2020
- */
-@Configuration
-public class SwaggerConfig {
-
-    @Bean
-    public OpenAPI customOpenAPI() {
-        return new OpenAPI()
-                .info(
-                        new Info()
-                                .title("Loyalty System Api")
-                                .version("1.0.0")
-                                .contact(
-                                        new Contact()
-                                                .email("me@upagge.ru")
-                                                .url("https://uPagge.ru")
-                                                .name("Struchkov Mark")
-                                )
-                );
-    }
-
-}
--- a/src/main/java/org/sadtech/example/swagger/controller/PointController.java
+++ b/src/main/java/org/sadtech/example/swagger/controller/PointController.java
@ -2,19 +2,23 @@ package org.sadtech.example.swagger.controller;

 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.tags.Tag;
+import jakarta.validation.constraints.Min;
+import jakarta.validation.constraints.NotBlank;
 import org.sadtech.example.swagger.dto.TypeOperation;
 import org.sadtech.example.swagger.dto.UserDto;
+import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestHeader;
 import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RequestPart;
+import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;

-import javax.validation.constraints.Min;
-import javax.validation.constraints.NotBlank;
 import java.util.Map;

 /**
@ -33,11 +37,12 @@ public class PointController {
    }

    @PostMapping("{key}")
+    @ApiResponse(responseCode = "400", description = "Неверный запрос — количество баллов должно быть неотрицательным")
    @Operation(summary = "Управление баллами", description = "Позволяет удалить или добавить баллы пользователю")
    public HttpStatus changePoints(
            @PathVariable @NotBlank @Parameter(description = "Идентификатор пользователя") String key,
-            @RequestPart("point") @Min(0) @Parameter(description = "Количество баллов", required = true) Long point,
-            @RequestPart("type") @Parameter(description = "Тип операции", required = true) TypeOperation type
+            @RequestParam("point") @Min(0) @Parameter(description = "Количество баллов", required = true, example = "100") Long point,
+            @RequestParam("type") @Parameter(description = "Тип операции", required = true, example = "PLUS") TypeOperation type
    ) {
        final UserDto userDto = repository.get(key);
        userDto.setPoints(
--- a/src/main/java/org/sadtech/example/swagger/controller/UserController.java
+++ b/src/main/java/org/sadtech/example/swagger/controller/UserController.java
@ -1,6 +1,8 @@
 package org.sadtech.example.swagger.controller;

+import io.swagger.v3.oas.annotations.ExternalDocumentation;
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.security.SecurityRequirement;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import org.sadtech.example.swagger.dto.UserDto;
 import org.springframework.http.HttpStatus;
@ -22,7 +24,14 @@ import static org.springframework.util.MimeTypeUtils.APPLICATION_JSON_VALUE;
 */
@RestController
@RequestMapping("/api/user")
-@Tag(name = "Пользователи", description = "Взаимодействие с пользователями")
+@Tag(
+        name = "User Controller",
+        description = "Контроллер для управления пользователями",
+        externalDocs = @ExternalDocumentation(
+                description = "Ссылка на общую документацию",
+                url = "https://example.com/docs/user-controller"
+        )
+)
 public class UserController {

    private final Map<String, UserDto> repository;
@ -48,9 +57,13 @@ public class UserController {
        return HttpStatus.OK;
    }

+    // http://localhost:8080/api/user/1
+    @SecurityRequirement(name = "jsessionid")
    @GetMapping(value = "{key}", produces = APPLICATION_JSON_VALUE)
    @Operation(summary = "Получить пользователя")
-    public ResponseEntity<UserDto> getSimpleDto(@PathVariable("key") String key) {
+    public ResponseEntity<UserDto> getSimpleDto(
+            @PathVariable("key") String key
+    ) {
        return ResponseEntity.ok(repository.get(key));
    }

--- a/src/main/java/org/sadtech/example/swagger/dto/UserDto.java
+++ b/src/main/java/org/sadtech/example/swagger/dto/UserDto.java
@ -2,7 +2,6 @@ package org.sadtech.example.swagger.dto;

 import io.swagger.v3.oas.annotations.media.Schema;

-import javax.validation.constraints.NotBlank;
 import java.time.LocalDateTime;

 /**
--- a/src/main/resources/application.properties
+++ b/src/main/resources/application.properties
@ -1 +0,0 @@
-
--- a/src/main/resources/application.yml
+++ b/src/main/resources/application.yml
@ -0,0 +1,25 @@
+#springdoc:
+#  swagger-ui:
+#    oauth:
+#      client-id: mocklab_oidc
+#      client-secret: whatever
+spring:
+  security:
+    oauth2:
+      client:
+        registration:
+          mocklab:
+            provider: mocklab
+            client-authentication-method: client_secret_basic
+            authorization-grant-type: authorization_code
+            scope: profile, email
+            redirect-uri: http://localhost:8080/login/oauth2/code/
+            clientId: mocklab_oidc
+            clientSecret: whatever
+        provider:
+          mocklab:
+            authorization-uri: https://oauth.wiremockapi.cloud/oauth/authorize
+            token-uri: https://oauth.wiremockapi.cloud/oauth/token
+            user-info-uri: https://oauth.wiremockapi.cloud/userinfo
+            user-name-attribute: sub
+            jwk-set-uri: https://oauth.wiremockapi.cloud/.well-known/jwks.json
Author	SHA1	Message	Date
Struchkov Mark	0e6e465fc7	Обновление mock конфигурации для oauth2	2024-11-04 10:36:59 +03:00
Struchkov Mark	e91208a7d0	Добавил пример с Oauth2	2024-11-04 10:24:20 +03:00
Struchkov Mark	2f4231b5c8	Добавил ApiResponse	2024-11-04 10:06:39 +03:00
Struchkov Mark	6aa4fe2f70	Добавил example	2024-11-04 09:51:35 +03:00
Struchkov Mark	a333537313	Добавил externalDocs	2024-11-04 09:13:36 +03:00
Struchkov Mark	5b8d0ad8d7	Обновление версий	2024-11-04 08:45:00 +03:00
Struchkov Mark	70a12d21c6	Поправил эндпойнт начисления баллов	2023-02-11 16:56:54 +03:00
Struchkov Mark	5d4970dc3b	Заменил SwaggerConfig	2023-02-11 14:45:06 +03:00
Struchkov Mark	3c956a976d	Обновил customOpenAPI	2023-02-11 12:54:39 +03:00
Struchkov Mark	77c2934d9c	Переход на SpringBoot 3	2023-02-11 12:54:26 +03:00
Struchkov Mark	2ffbaebcfa	update dependencies	2023-02-11 10:11:24 +03:00