? ?????? Spring Boot ???????? OpenAPI? ???? ?? URL?? Swagger UI?? ??? ????? ???? ??? ???????. ? ??? ?? API ??? ???? ???? ? ?? ??? ? ?? ???.

OpenAPI ? ??

?? OpenAPI ??? ??? ???? ?? ?? ???? ??? ?????.

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.boot.info.GitProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class OpenAPIConfig {

    @Bean
    public OpenAPI customOpenAPI(GitProperties gitProperties) {
        return new OpenAPI()
                .info(new Info()
                        .title("Book Catalog API")
                        .description("REST API for managing a book catalog. Application version: "+ gitProperties.get("build.version"))
                        .version("1.0.0")
                        .contact(new Contact()
                                .name("Book Catalog Team")
                                .email("support@bookcatalog.com")
                                .url("https://github.com/vlaship/book-catalog"))
                        .license(new License()
                                .name("MIT License")
                                .url("https://opensource.org/licenses/MIT"))
                );
    }
}

? ??? API? ?? ?? ??? ??? ??? ?? OpenAPI Bean? ?????. ??? ??, ????, ?? ?? ? ????? ???? ?? ?? ???? ? ????.
GitProperties? ???? ??? ??? ??? ? ????.

?? URL ???? ????

???? ???? ?? URL?? Swagger UI? ?????? ????? ??? ?????.

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class OpenApiController {
    @GetMapping("/")
    public String index() {
        return "redirect:swagger-ui.html";
    }
}

? ??? ????? ?? URL("/")? @GetMapping? ???? Swagger UI HTML ???? ???????.

application.yaml ???? ?

application.yml???? ??? ? ?? ??? ?????? ??? ??? ??? ???? ? ??? ??? ???.

spring:
  application:
    name: book-catalog
    version: '@project.version@'
  mvc:
    problemdetails:
      enabled: true

management:
  endpoints:
    web:
      exposure:
        include: '*'
  info:
    git:
      mode: full

server:
  port: 8888
  servlet:
    context-path: /${spring.application.name}
  error:
    whitelabel:
      enabled: false

??? YAML ??? Spring Boot ??????? ?? ?? ??? ????.

1. ?????? ??:

name: ??????? ??? ?????. ???? book-catalog? ?????.

version: ?????? ??? ???? ?? ?? ???? ?? ??? ???? ?? ?? ???? ?????.

1. MVC ??:

problemdetails.enabled: ??? ?? ?? ???? ??? ?? ???? ??????.

1. ?? ?????:

endpoints.web.exposure.include: '*':** ???? ? ?? ???? ?? ????? ?????? ?????.

info.git.mode: full: /info ??????? ??? Git ??? ?????.

1. ?? ??:

??: ??? ???? ??? ???? ??? ?????(??? 8080, ???? 8888? ???).

servlet.context-path: ??????? ???? ??? ???? ??? ???? ?????? ???.

error.whitelabel.enabled: false: ?? ????? ?? ???? ?????? ?? ?? ? ?? ??? ???? ?? ???? ?????.

??.txt ??

1. ??.txt ?? ??

Spring Boot ????? src/main/resources ????? ??.txt?? ? ??? ????.

2. ??.txt? ??? ???? ??

? ???? ???? ASCII ??? ??? ? ????. ?? ??? ????.

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.boot.info.GitProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class OpenAPIConfig {

    @Bean
    public OpenAPI customOpenAPI(GitProperties gitProperties) {
        return new OpenAPI()
                .info(new Info()
                        .title("Book Catalog API")
                        .description("REST API for managing a book catalog. Application version: "+ gitProperties.get("build.version"))
                        .version("1.0.0")
                        .contact(new Contact()
                                .name("Book Catalog Team")
                                .email("support@bookcatalog.com")
                                .url("https://github.com/vlaship/book-catalog"))
                        .license(new License()
                                .name("MIT License")
                                .url("https://opensource.org/licenses/MIT"))
                );
    }
}

? ?? ??? ?????? ??? ???? ??? ??? ??? ??? ??? ?????.

Dockerfile ??

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class OpenApiController {
    @GetMapping("/")
    public String index() {
        return "redirect:swagger-ui.html";
    }
}

??? ??: ???? ?? ??? ???? ???? ?? ???? ??? ??? ?? ????? ????.
??? ??: ??? ?? ????? ???? ?? ??? ??? ???? ???? ?? ???? ? ?? ????? ????.
?? ?? ???: azul/zulu-openjdk-alpine:21-jre-headless? ?? ?? ?? ???? ???? ??? ??? ?? ????.

? ?? ??? ???? Docker ???? ? Spring Boot ??????? ?? ??? ???? ??? ??? ???? ???? ??? ?????.

? ??? SpringBoot ? ??? - ?? ?? ??? ?? ?????. ??? ??? PHP ??? ????? ?? ?? ??? ?????!