54.3. Spring 引导实现
这部分论述了如何在 Spring Boot 中使用 Swagger2Feature。
请注意,对于 OpenAPI 3 的实现,请使用 OpenApiFeature(org.apache.cxf.jaxrs.openapi.OpenApiFeature
)。
54.3.1. Quickstart 示例 复制链接链接已复制到粘贴板!
Quickstart 示例(https://github.com/fabric8-quickstarts/spring-boot-cxf-jaxrs
)演示了如何将 Apache CXF 与 Spring Boot 搭配使用。Quickstart 使用 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
,ApiResponse
, 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 文件