54.3. Spring Boot 実装
本セクションでは、Spring Boot で Swagger2Feature を使用する方法について説明します。
OpenAPI 3 実装では、OpenApiFeature (org.apache.cxf.jaxrs.openapi.OpenApiFeature
) を使用することに注意してください。
54.3.1. クイックスタートの例 リンクのコピーリンクがクリップボードにコピーされました!
クイックスタートサンプル (https://github.com/fabric8-quickstarts/spring-boot-cxf-jaxrs
) は、Spring Boot で Apache CXF を使用する方法を実証します。クイックスタートは Spring Boot を使用して、Swagger が有効な CXF JAX-RS エンドポイントが含まれるアプリケーションを設定します。
54.3.2. Swagger の有効化 リンクのコピーリンクがクリップボードにコピーされました!
Swagger を有効にするには、以下の操作が必要です。
REST アプリケーションで以下を行います。
Swagger2Feature をインポートする。
import org.apache.cxf.jaxrs.swagger.Swagger2Feature;
import org.apache.cxf.jaxrs.swagger.Swagger2Feature;
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Swagger2Feature を CXF エンドポイントに追加する。
endpoint.setFeatures(Arrays.asList(new Swagger2Feature()));
endpoint.setFeatures(Arrays.asList(new Swagger2Feature()));
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 例は、例 55.1: REST アプリケーションの例 を参照してください。
Java 実装ファイルで、サービスが必要とする各アノテーションの Swagger API アノテーションをインポートします。
import io.swagger.annotations.*
import io.swagger.annotations.*
Copy to Clipboard Copied! Toggle word wrap Toggle overflow ここで、* は
Api
、ApiOperation
、ApiParam
、ApiResponse
、ApiResponses
などです。詳細は、
https://github.com/swagger-api/swagger-core/wiki/Annotations
を参照してください。例は、例 55.2: Java 実装ファイル を参照してください。
Java ファイルで、Swagger アノテーションを JAX-RS でアノテーションが付けられたエンドポイント (
@PATH
、@PUT
、@POST
、@GET
、@Produces
、@Consumes
、@DELETE
、@PathParam
など) に追加します。例は、例 55.3: Java ファイル を参照してください。
例 55.1: REST アプリケーションの例
例 55.2: Java 実装ファイル
例 55.3: Java ファイル