Add swagger

core/client/src/main/java/ru/practicum/shareit/server/client/item/ItemClient.java

@@ -44,7 +44,7 @@ public ItemDetailsDto getItemById(Long itemId, Long userId) {
                 .block();
     }
 
-    public List<ItemDetailsDto> getItemsByOwnerId(Long userId, Integer from, Integer size) {
+    public List<ItemDetailsDto> getItemsByUserId(Long userId, Integer from, Integer size) {
         return client.get()
                 .uri(builder -> builder.path("/items")
                         .queryParam("from", from)
@@ -57,7 +57,7 @@ public List<ItemDetailsDto> getItemsByOwnerId(Long userId, Integer from, Integer
                 .block();
     }
 
-    public List<ItemDto> searchItemsByNameOrDescription(String text, Integer from, Integer size) {
+    public List<ItemDto> getItemsByText(String text, Integer from, Integer size) {
         return client.get()
                 .uri(builder -> builder.path("/items/search")
                         .queryParam("text", text)

core/client/src/main/java/ru/practicum/shareit/server/client/itemrequest/ItemRequestClient.java

@@ -44,7 +44,7 @@ public ItemRequestDto getItemRequestById(Long itemRequestId, Long userId) {
                 .block();
     }
 
-    public List<ItemRequestDto> getItemRequestsByRequesterId(Long userId, Integer from, Integer size) {
+    public List<ItemRequestDto> getItemRequests(Long userId, Integer from, Integer size) {
         return client.get()
                 .uri(builder -> builder.path("/requests/all")
                         .queryParam("from", from)

core/client/src/main/java/ru/practicum/shareit/server/client/user/UserClient.java

@@ -22,25 +22,24 @@ public UserDto addUser(UserCreationDto userDto) {
                 .block();
     }
 
-    public UserDto updateUser(UserCreationDto userDto, Long userId) {
-        return client.patch()
+    public UserDto getUserById(Long userId) {
+        return client.get()
                 .uri("/users/{id}", userId)
-                .bodyValue(userDto)
                 .retrieve()
                 .bodyToMono(UserDto.class)
                 .block();
     }
 
-    public UserDto getUserById(Long userId) {
-        return client.get()
+    public UserDto updateUser(UserCreationDto userDto, Long userId) {
+        return client.patch()
                 .uri("/users/{id}", userId)
+                .bodyValue(userDto)
                 .retrieve()
                 .bodyToMono(UserDto.class)
                 .block();
     }
 
-
-    public List<UserDto> getAllUsers(Integer from, Integer size) {
+    public List<UserDto> getUsers(Integer from, Integer size) {
         return client.get()
                 .uri(builder -> builder.path("/users")
                         .queryParam("from", from)

core/consts/src/main/java/ru/practicum/shareit/server/constants/OpenApiConsts.java

@@ -0,0 +1,177 @@
+package ru.practicum.shareit.server.constants;
+
+import lombok.experimental.UtilityClass;
+
+/**
+ * name = description
+ * <p>
+ * EG (exempli gratia) = example
+ */
+@UtilityClass
+public class OpenApiConsts {
+
+    @UtilityClass
+    public static class Param {
+        public static final String FROM = "Количество элементов, которые нужно пропустить для формирования текущего набора";
+        public static final String SIZE = "Количество элементов в наборе";
+        public static final String USER_ID = "Идентификатор пользователя";
+        public static final String ITEM_REQUEST_ID = "Идентификатор запроса вещи";
+        public static final String ITEM_ID = "Идентификатор вещи";
+        public static final String FROM_EG = "10";
+        public static final String SIZE_EG = "20";
+        public static final String USER_ID_EG = User.ID_EG;
+        public static final String ITEM_REQUEST_ID_EG = ItemRequest.ID_EG;
+        public static final String ITEM_ID_EG = Item.ID_EG;
+    }
+
+    @UtilityClass
+    public static class User {
+        public static final String ID = "Идентификатор";
+        public static final String NAME = "Имя";
+        public static final String EMAIL = "Адрес электронной почты";
+        public static final String ID_EG = "1";
+        public static final String NAME_EG = "Вася Уточкин";
+        public static final String EMAIL_EG = "vasya.utochkin@example.org";
+    }
+
+    @UtilityClass
+    public static class Item {
+        public static final String ID = "Идентификатор";
+        public static final String NAME = "Название";
+        public static final String DESCRIPTION = "Описание";
+        public static final String IS_AVAILABLE = "Доступность";
+        public static final String REQUEST_ID = "Идентификатор запроса";
+        public static final String ID_EG = "4";
+        public static final String NAME_EG = "Щётка для обуви";
+        public static final String DESCRIPTION_EG = "Стандартная щётка для обуви";
+        public static final String IS_AVAILABLE_EG = "true";
+        public static final String REQUEST_ID_EG = ItemRequest.ID_EG;
+    }
+
+    @UtilityClass
+    public static class ItemRequest {
+        public static final String ID = "Идентификатор";
+        public static final String DESCRIPTION = "Описание";
+        public static final String CREATED = "Дата и время создания";
+        public static final String ITEMS = "Вещи, добавленные по запросу";
+        public static final String ID_EG = "1";
+        public static final String DESCRIPTION_EG = "Хотел бы воспользоваться щёткой для обуви";
+    }
+
+    @UtilityClass
+    public static class Booking {
+        public static final String ID = "Идентификатор";
+        public static final String ID_EG = "5";
+    }
+
+    @UtilityClass
+    public static class Comment {
+        public static final String ID = "Идентификатор";
+        public static final String TEXT = "Текст комментария";
+        public static final String AUTHOR_NAME = "Имя автора";
+        public static final String CREATED = "Дата и время создания";
+        public static final String ID_EG = "7";
+        public static final String TEXT_EG = "Все прошло хорошо, рекомендую!";
+        public static final String AUTHOR_NAME_EG = User.NAME_EG;
+    }
+
+    @UtilityClass
+    public static class ApiError {
+        public static final String STATUS = "статус HTTP-ответа";
+        public static final String REASON = "Общее описание ошибки";
+        public static final String MESSAGE = "Сообщение об ошибке";
+        public static final String TIMESTAMP = "Дата и время когда произошла ошибка";
+        public static final String ERRORS = "Сопутствующие ошибки или иная информация(вложенные ошибки, стектрейсы и пр.)";
+        public static final String STATUS_EG = "BAD_REQUEST";
+        public static final String REASON_EG = "Request cannot be understood by the server due to incorrect syntax";
+        public static final String MESSAGE_EG = "Unknown state: ABC";
+        public static final String ERRORS_EG = "[" +
+                "\"parameter 'size' must be greater than 0, but it was '0'\"," +
+                "\"parameter 'from' must be greater than or equal to 0, but it was '-1'\"" +
+                "]";
+    }
+
+    @UtilityClass
+    public static class Response {
+
+        public static final String GET_PAGINATION_BAD_REQUEST = "{" +
+                "\"status\":\"BAD_REQUEST\"," +
+                "\"reason\":\"Bad Request\"," +
+                "\"message\":\"Parameter(s) failed validation\"," +
+                "\"errors\":[" +
+                "\"parameter 'size' must be greater than 0, but it was '0'\"," +
+                "\"parameter 'from' must be greater than or equal to 0, but it was '-1'\"" +
+                "]," +
+                "\"timestamp\":\"2023-10-17T16:59:11.237789\"" +
+                "}";
+
+        public static final String POST_USER_BAD_REQUEST = "{" +
+                "\"status\":\"BAD_REQUEST\"," +
+                "\"reason\":\"Bad Request\"," +
+                "\"message\":\"Field(s) failed validation\"," +
+                "\"errors\":[" +
+                "\"field 'email' must have the format of an email address, but it was 'vasyaexample.com'\"" +
+                "]," +
+                "\"timestamp\":\"2023-10-17T19:12:12.08784\"" +
+                "}";
+
+        public static final String POST_USER_CONFLICT = "{" +
+                "\"status\":\"CONFLICT\"," +
+                "\"reason\":\"Request conflicts with another request or with server configuration\"," +
+                "\"message\":\"User email must be unique\"," +
+                "\"timestamp\":\"2023-10-17T19:27:41.322698\"" +
+                "}";
+
+        public static final String USER_NOT_FOUND = "{" +
+                "\"status\":\"NOT_FOUND\"," +
+                "\"reason\":\"Requested resource does not exist\"," +
+                "\"message\":\"User with id: 1 not found\"," +
+                "\"timestamp\":\"2023-10-17T21:25:18.098461\"" +
+                "}";
+
+        public static final String ITEM_REQUEST_BAD_REQUEST = "{" +
+                "\"status\":\"BAD_REQUEST\"," +
+                "\"reason\":\"Bad Request\"," +
+                "\"message\":\"Field(s) failed validation\"," +
+                "\"errors\":[" +
+                "\"field 'description' should not be empty, but it was 'null'\"" +
+                "]," +
+                "\"timestamp\":\"2023-10-18T14:42:50.201833\"" +
+                "}";
+
+        public static final String POST_ITEM_REQUEST_OK = "{" +
+                "\"id\":1," +
+                "\"description\":\"Хотел бы воспользоваться щёткой для обуви\"," +
+                "\"created\":\"2023-10-18T14:49:08.869138\"," +
+                "\"items\":null" +
+                "}";
+
+        public static final String ITEM_REQUEST_NOT_FOUND = "{" +
+                "\"status\":\"NOT_FOUND\"," +
+                "\"reason\":\"Requested resource does not exist\"," +
+                "\"message\":\"Item request with id: 99 not found\"," +
+                "\"timestamp\":\"2023-10-18T15:20:42.426754\"" +
+                "}";
+
+        public static final String COMMENT_BAD_REQUEST = "{" +
+                "\"status\":\"BAD_REQUEST\"," +
+                "\"reason\":\"Request cannot be understood by the server due to incorrect syntax\"," +
+                "\"message\":\"Unable to leave comment for item with id: 1: no approved booking for user with id: 4 or booking is not yet finished\"," +
+                "\"timestamp\":\"2023-10-19T09:57:46.77556\"" +
+                "}";
+
+        public static final String ITEM_NOT_FOUND = "{" +
+                "\"status\":\"NOT_FOUND\"," +
+                "\"reason\":\"Requested resource does not exist\"," +
+                "\"message\":\"Item not found with id: 99\"," +
+                "\"timestamp\":\"2023-10-19T10:11:42.797793\"" +
+                "}";
+
+        public static final String ITEM_FORBIDDEN = "{" +
+                "\"status\":\"FORBIDDEN\"," +
+                "\"reason\":\"Access denied\"," +
+                "\"message\":\"User with id: 8 is not owner of item with id: 1\"," +
+                "\"timestamp\":\"2023-10-19T11:12:52.394164\"" +
+                "}";
+    }
+}

core/dto/pom.xml

@@ -32,5 +32,11 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-validation</artifactId>
         </dependency>
+        <dependency>
+            <groupId>ru.practicum</groupId>
+            <artifactId>shareit-server-constants</artifactId>
+            <version>${shareit-server-constants.version}</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
 </project>

core/dto/src/main/java/ru/practicum/shareit/server/dto/error/ApiError.java

@@ -2,27 +2,43 @@
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
+import io.swagger.v3.oas.annotations.media.ArraySchema;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.AccessLevel;
 import lombok.Builder;
 import lombok.Getter;
 import lombok.experimental.FieldDefaults;
 import lombok.extern.jackson.Jacksonized;
+import ru.practicum.shareit.server.constants.OpenApiConsts;
 
 import java.time.LocalDateTime;
 import java.util.List;
 
+@Schema(description = "Сведения об ошибке")
 @Jacksonized
 @Builder
 @FieldDefaults(level = AccessLevel.PRIVATE, makeFinal = true)
 @Getter
 public class ApiError {
+
+    @Schema(description = OpenApiConsts.ApiError.STATUS, example = OpenApiConsts.ApiError.STATUS_EG)
     String status;
+
+    @Schema(description = OpenApiConsts.ApiError.REASON, example = OpenApiConsts.ApiError.REASON_EG)
     String reason;
+
+    @Schema(description = OpenApiConsts.ApiError.MESSAGE, example = OpenApiConsts.ApiError.MESSAGE_EG)
     String message;
 
+    @ArraySchema(arraySchema = @Schema(
+            description = OpenApiConsts.ApiError.ERRORS,
+            example = OpenApiConsts.ApiError.ERRORS_EG,
+            nullable = true
+    ))
     @JsonInclude(Include.NON_NULL)
     List<String> errors;
 
+    @Schema(description = OpenApiConsts.ApiError.TIMESTAMP)
     @Builder.Default
     LocalDateTime timestamp = LocalDateTime.now();
 }

core/dto/src/main/java/ru/practicum/shareit/server/dto/item/request/ItemCreationDto.java

@@ -1,30 +1,37 @@
 package ru.practicum.shareit.server.dto.item.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.*;
 import lombok.experimental.FieldDefaults;
+import ru.practicum.shareit.server.constants.OpenApiConsts;
 import ru.practicum.shareit.server.dto.validation.Groups;
 import ru.practicum.shareit.server.dto.validation.annotation.NullableNotBlank;
 
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.NotNull;
 
+@Schema(description = "Информация о вещи")
 @FieldDefaults(level = AccessLevel.PRIVATE)
 @Setter
 @Getter
 @ToString
 @NoArgsConstructor
 public class ItemCreationDto {
 
+    @Schema(description = OpenApiConsts.Item.NAME, example = OpenApiConsts.Item.NAME_EG)
     @NotBlank(groups = Groups.OnCreate.class)
     @NullableNotBlank(groups = Groups.OnUpdate.class)
     String name;
 
+    @Schema(description = OpenApiConsts.Item.DESCRIPTION, example = OpenApiConsts.Item.DESCRIPTION_EG)
     @NotBlank(groups = Groups.OnCreate.class)
     @NullableNotBlank(groups = Groups.OnUpdate.class)
     String description;
 
+    @Schema(description = OpenApiConsts.Item.IS_AVAILABLE, example = OpenApiConsts.Item.IS_AVAILABLE_EG)
     @NotNull(groups = Groups.OnCreate.class)
     Boolean available;
 
+    @Schema(description = OpenApiConsts.Item.REQUEST_ID, example = OpenApiConsts.Item.REQUEST_ID_EG)
     Long requestId;
 }

core/dto/src/main/java/ru/practicum/shareit/server/dto/item/request/comment/CommentCreationDto.java

@@ -1,17 +1,22 @@
 package ru.practicum.shareit.server.dto.item.request.comment;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.*;
 import lombok.experimental.FieldDefaults;
+import ru.practicum.shareit.server.constants.OpenApiConsts;
 import ru.practicum.shareit.server.dto.validation.Groups;
 
 import javax.validation.constraints.NotEmpty;
 
+@Schema(description = "Данные комментария (отзыва)")
 @FieldDefaults(level = AccessLevel.PRIVATE)
 @Setter
 @Getter
 @ToString
 @NoArgsConstructor
 public class CommentCreationDto {
+
+    @Schema(description = OpenApiConsts.Comment.TEXT, example = OpenApiConsts.Comment.TEXT_EG)
     @NotEmpty(groups = Groups.OnCreate.class)
     String text;
 }