この投稿では、Spring Boot アプリケーションで OpenAPI を構(gòu)成し、ルート URL から Swagger UI への便利なリダイレクトを追加する方法を説明します。この設(shè)定により、API ドキュメントが改善され、開発者がアクセスしやすくなります。

OpenAPI Beanの構(gòu)成

まず、OpenAPI ドキュメントをカスタマイズするための構(gòu)成クラスを作成しましょう。

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"))
                );
    }
}

この構(gòu)成では、API に関する基本情報を含むカスタム OpenAPI Bean が作成されます。連絡(luò)先情報、ライセンス、外部ドキュメントなどの詳細(xì)を追加して、これをさらにカスタマイズできます。
GitProperties を使用して詳細(xì)を提供できます。

ルート 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 の更新

この構(gòu)成ファイルは、多くの場合 application.yml という名前で、アプリケーションの動作のさまざまな側(cè)面を定義する上で重要な役割を果たします。

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 構(gòu)成は、Spring Boot アプリケーションのいくつかの主要な領(lǐng)域をカバーします。

1. アプリケーションのプロパティ:

name: アプリケーションの名前を定義します。ここでは book-catalog に設(shè)定します。

version: アプリケーションのバージョンを指定するために、ビルド プロセス中に設(shè)定される可能性があるプレースホルダーを參照します。

1. MVC 構(gòu)成:

problemdetails.enabled: 例外の応答本文で詳細(xì)な問題レポートを有効にします。

1. 管理エンドポイント:

endpoints.web.exposure.include: '*':** 監(jiān)視と管理の目的ですべてのアクチュエータ エンドポイントを公開します。

info.git.mode: full: /info エンドポイントで詳細(xì)な Git 情報を提供します。

1. サーバー構(gòu)成:

port: サーバーが受信リクエストをリッスンするポートを設(shè)定します (デフォルトは 8080、ここでは 8888 に設(shè)定します)。

servlet.context-path: アプリケーションのコンテキスト パスを定義し、リクエストが正しくルーティングされるようにします。

error.whitelabel.enabled: false: デフォルトのホワイトラベル エラー ページを無効にし、開発中により有益なエラー メッセージを表示できるようにします。

Banner.txtの追加

1. Banner.txt ファイルを作成します

Spring Boot プロジェクトの src/main/resources ディレクトリ內(nèi)に、banner.txt という名前の新しいファイルを作成します。

2.サービスの詳細(xì)をbanner.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";
    }
}

レイヤー抽出: 依存関係用に個別のレイヤーを作成し、ビルド効率を向上させ、イメージ サイズの更新を削減します。
マルチステージ ビルド: マルチステージ ビルド プロセスを利用してビルド環(huán)境をランタイム環(huán)境から分離することで、より小型で効率的な最終イメージが得られます。
軽量ベース イメージ: azul/zulu-openjdk-alpine:21-jre-headless のような最小限のベース イメージを使用して、イメージ サイズをさらに小さくします。

このアプローチにより、ビルドが高速化され、イメージ サイズが小さくなり、Docker コンテナー內(nèi)の Spring Boot アプリケーションの全體的なパフォーマンスが向上します。

以上がSpringBoot Web サービス - 初期構(gòu)成の一部の詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國語 Web サイトの他の関連記事を參照してください。