SpringBootとSwaggerを統合する方法は何ですか？

1年 ago
光, 明
1 minute

Spring BootとSwaggerを統合する方法は、以下の手順があります。

  1. pom.xmlファイル
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-boot-starter</artifactId>
   <version>3.0.0</version>
</dependency>
  1. Swagger設定クラスを作成する：Swaggerの関連情報やルールを設定するためのSwagger設定クラスを作成します。以下にサンプルコードを示します：
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() { 
        return new Docket(DocumentationType.SWAGGER_2)  
          .select()                                  
          .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))              
          .paths(PathSelectors.any())                          
          .build();
    }
}

上記のコードでは、basePackageメソッドはAPIドキュメントを生成する必要があるパッケージのパスを指定しており、実際の状況に応じて変更することができます。

  1. Swagger2を有効にする
@SpringBootApplication
@EnableSwagger2
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}
  1. http://localhost:8080/swagger-ui.html
    ローカルホストの8080ポートにswagger-ui.htmlページがあります。

注意：Swagger 2.xバージョンが使用されている場合、Swagger 3.xバージョンを使用する場合は、対応する依存関係と設定クラスを調整する必要があります。

bannerAds