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 文件