Add swagger

pom.xml

@@ -2,12 +2,14 @@
 <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>
+
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
         <version>2.7.4</version>
         <relativePath/> <!-- lookup parent from repository -->
     </parent>
+
     <groupId>ru.yandex.practicum</groupId>
     <artifactId>filmorate</artifactId>
     <version>0.0.1-SNAPSHOT</version>
@@ -18,6 +20,8 @@
         <java.version>11</java.version>
         <lombok.version>1.18.10</lombok.version>
         <logbook.version>2.14.0</logbook.version>
+        <swagger-annotations.version>2.2.2</swagger-annotations.version>
+        <springdoc-openapi-ui.version>1.6.9</springdoc-openapi-ui.version>
     </properties>
 
     <dependencies>
@@ -54,6 +58,17 @@
             <artifactId>spring-boot-devtools</artifactId>
             <optional>true</optional>
         </dependency>
+
+        <dependency>
+            <groupId>io.swagger.core.v3</groupId>
+            <artifactId>swagger-annotations</artifactId>
+            <version>${swagger-annotations.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-ui</artifactId>
+            <version>${springdoc-openapi-ui.version}</version>
+        </dependency>
     </dependencies>
 
     <build>

src/main/java/ru/yandex/practicum/filmorate/SwaggerConfig.java

@@ -0,0 +1,19 @@
+package ru.yandex.practicum.filmorate;
+
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class SwaggerConfig {
+    @Bean
+    public OpenAPI customOpenAPI() {
+        return new OpenAPI()
+                .info(
+                        new Info()
+                                .title("Filmorate Swagger Api")
+                                .version("1.0.0")
+                );
+    }
+}

src/main/java/ru/yandex/practicum/filmorate/controller/FilmController.java

@@ -1,5 +1,8 @@
 package ru.yandex.practicum.filmorate.controller;
 
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.PutMapping;
@@ -14,20 +17,37 @@
 
 @RestController
 @RequestMapping("/films")
+@Tag(name = "Films", description = "управление фильмами")
 public class FilmController {
 
-    private Storage<Film> storage = new Storage();
+    private final Storage<Film> storage;
+
+    @Autowired
+    public FilmController(Storage<Film> storage) {
+        this.storage = storage;
+    }
 
     @GetMapping
+    @Operation(
+            summary = "Получение списка всех фильмов"
+    )
     public List<Film> getAllFilms() {
         return storage.getAllItems();
     }
 
     @PostMapping
+    @Operation(
+            summary = "Добавление фильма",
+            description = "нет проверки на уникальность"
+    )
     public Film addNewFilm(@RequestBody @Valid Film film) {
         return storage.add(film);
     }
 
+    @Operation(
+            summary = "Обновление фильма",
+            description = "для существующих фильмов"
+    )
     @PutMapping
     public Film updateFilm(@RequestBody @Valid Film film) {
         return storage.update(film);

src/main/java/ru/yandex/practicum/filmorate/controller/UserController.java

@@ -1,5 +1,8 @@
 package ru.yandex.practicum.filmorate.controller;
 
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.PutMapping;
@@ -14,20 +17,37 @@
 
 @RestController
 @RequestMapping("/users")
+@Tag(name = "Users", description = "управление пользователями")
 public class UserController {
 
-    private Storage<User> storage = new Storage();
+    private final Storage<User> storage;
 
+    @Autowired
+    public UserController(Storage<User> storage) {
+        this.storage = storage;
+    }
+
+    @Operation(
+            summary = "Получение списка всех пользователей"
+    )
     @GetMapping
     public List<User> getAllUsers() {
         return storage.getAllItems();
     }
 
+    @Operation(
+            summary = "Добавление пользователя",
+            description = "нет проверки на уникальность"
+    )
     @PostMapping
     public User addUser(@RequestBody @Valid User user) {
         return storage.add(user);
     }
 
+    @Operation(
+            summary = "Обновление пользователя",
+            description = "для существующих пользователей"
+    )
     @PutMapping
     public User updateUser(@RequestBody @Valid User user) {
         return storage.update(user);

src/main/java/ru/yandex/practicum/filmorate/model/Film.java

@@ -1,5 +1,6 @@
 package ru.yandex.practicum.filmorate.model;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 import lombok.RequiredArgsConstructor;
 import ru.yandex.practicum.filmorate.helper.ReleaseDate;
@@ -12,13 +13,20 @@
 @Data
 @RequiredArgsConstructor
 public class Film implements IdControl {
+
+    @Schema(accessMode = Schema.AccessMode.READ_ONLY)
     private int id;
     @NotBlank(message = "'name' should non be empty")
     private String name;
     @Size(max = 200, message = "'description' should have length no more than 200")
     private String description;
+
+    @Schema(description = "Дата выхода. Старше 28 декабря 1895 года")
     @ReleaseDate
     private LocalDate releaseDate;
+    @Schema(
+            description = "Продолжительность (в секундах). Больше нуля",
+    example = "9000")
     @Positive
     private int duration;
 

src/main/java/ru/yandex/practicum/filmorate/service/Storage.java

@@ -1,5 +1,6 @@
 package ru.yandex.practicum.filmorate.service;
 
+import org.springframework.stereotype.Service;
 import ru.yandex.practicum.filmorate.model.IdControl;
 
 import java.util.ArrayList;
@@ -8,6 +9,7 @@
 import java.util.NoSuchElementException;
 import java.util.Optional;
 
+@Service
 public class Storage<T extends IdControl> {
     private HashSet<T> itemList = new HashSet<>();
     private int currentItemId = 1;