54.3. Spring Boot 实现
这部分论述了如何在 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)演示了如何在 Spring Boot 中使用 Apache CXF。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 在 CXF 端点中添加 Swagger2Feature:
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 文件