Swagger文書をSpringBootに統合する方法を教えてください。

10か月 ago

蓮, 翼

1 minute

SpringBootにSwaggerドキュメントを統合する方法は、次の手順に従うことができます。

Swaggerの依存関係を追加します：
プロジェクトのpom.xmlファイルにSwaggerの依存関係を追加します。

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

Swaggerを設定する：
SpringBootの設定クラスにSwaggerの設定を追加する、例えば：

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}

アプリケーションを起動してください：
SpringBootアプリケーションを起動した後、http://localhost:8080/swagger-ui/index.html にアクセスしてSwaggerドキュメントを確認できます。

SpringBootアプリケーションにSwaggerドキュメントを統合するには、上記の手順に従ってください。Swaggerは開発者がAPIインターフェースを簡単に閲覧およびテストできるようにします。