Compare commits
10 Commits
Author | SHA1 | Date | |
---|---|---|---|
406b1ebffd | |||
2f4231b5c8 | |||
6aa4fe2f70 | |||
a333537313 | |||
5b8d0ad8d7 | |||
70a12d21c6 | |||
5d4970dc3b | |||
3c956a976d | |||
77c2934d9c | |||
2ffbaebcfa |
51
pom.xml
51
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>
|
||||
@ -24,15 +27,36 @@
|
||||
<artifactId>spring-boot-starter-web</artifactId>
|
||||
</dependency>
|
||||
|
||||
<dependency>
|
||||
<groupId>io.swagger.core.v3</groupId>
|
||||
<artifactId>swagger-annotations</artifactId>
|
||||
<version>2.1.6</version>
|
||||
</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>
|
||||
|
||||
<!-- jwt dependencies -->
|
||||
<dependency>
|
||||
<groupId>io.jsonwebtoken</groupId>
|
||||
<artifactId>jjwt-api</artifactId>
|
||||
<version>0.11.5</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>io.jsonwebtoken</groupId>
|
||||
<artifactId>jjwt-impl</artifactId>
|
||||
<version>0.11.5</version>
|
||||
<scope>runtime</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>io.jsonwebtoken</groupId>
|
||||
<artifactId>jjwt-jackson</artifactId>
|
||||
<version>0.11.5</version>
|
||||
<scope>runtime</scope>
|
||||
</dependency>
|
||||
|
||||
<dependency>
|
||||
<groupId>javax.xml.bind</groupId>
|
||||
<artifactId>jaxb-api</artifactId>
|
||||
<version>2.3.1</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
@ -45,4 +69,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>
|
||||
|
@ -0,0 +1,31 @@
|
||||
package org.sadtech.example.swagger.config;
|
||||
|
||||
import io.swagger.v3.oas.annotations.OpenAPIDefinition;
|
||||
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 = "JWT",
|
||||
type = SecuritySchemeType.HTTP,
|
||||
bearerFormat = "JWT",
|
||||
scheme = "bearer"
|
||||
)
|
||||
public class OpenApiConfig {
|
||||
|
||||
}
|
@ -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")
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
}
|
@ -2,7 +2,12 @@ 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.responses.ApiResponse;
|
||||
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
|
||||
import io.swagger.v3.oas.annotations.tags.Tag;
|
||||
import jakarta.servlet.http.HttpServletRequest;
|
||||
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.HttpStatus;
|
||||
@ -10,11 +15,9 @@ 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.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 +36,14 @@ public class PointController {
|
||||
}
|
||||
|
||||
@PostMapping("{key}")
|
||||
@SecurityRequirement(name = "JWT")
|
||||
@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
|
||||
@PathVariable @NotBlank @Parameter(description = "Идентификатор пользователя", example = "key1") String key,
|
||||
@RequestParam("point") @Min(0) @Parameter(description = "Количество баллов", required = true, example = "100") Long point,
|
||||
@RequestParam("type") @Parameter(description = "Тип операции", required = true, example = "PLUS") TypeOperation type,
|
||||
HttpServletRequest request
|
||||
) {
|
||||
final UserDto userDto = repository.get(key);
|
||||
userDto.setPoints(
|
||||
|
@ -1,5 +1,6 @@
|
||||
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.tags.Tag;
|
||||
import org.sadtech.example.swagger.dto.UserDto;
|
||||
@ -22,7 +23,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;
|
||||
|
@ -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;
|
||||
|
||||
/**
|
||||
|
Loading…
Reference in New Issue
Block a user