enunciate-swagger 如何使用

enunciate-swagger 是一个基于 Enunciate 的插件，可以生成 Swagger 规范的 API 文档。要使用 enunciate-swagger，需要按照以下步骤进行操作：

1. 在项目的 pom.xml 文件中添加 enunciate-swagger 插件的依赖：

<dependency>
    <groupId>com.webcohesion.enunciate</groupId>
    <artifactId>enunciate-swagger-annotations</artifactId>
    <version>1.30</version>
</dependency>

2. 在 Enunciate 的配置文件中添加 enunciate-swagger 插件的配置：

<enunciate>
    <modules>
        <swagger/>
    </modules>
</enunciate>

3. 在 API 的代码中，使用 enunciate-swagger 提供的注解来描述 API 的信息，例如：

@Api(value = "pet", description = "Operations about pets")
public interface PetApi {

    @ApiOperation(value = "Find pet by ID", notes = "Returns a pet when ID <code>id</code> exists.")
    @ApiResponses(value = {
            @ApiResponse(code = 400, message = "Invalid ID supplied"),
            @ApiResponse(code = 404, message = "Pet not found")})
    @GET
    @Path("/{id}")
    @Produces({"application/xml", "application/json"})
    Pet getPetById(
            @ApiParam(value = "ID of pet that needs to be fetched", allowableValues = "range[1,10]", required = true)
            @PathParam("id") Long id);
}

4. 运行 Enunciate 的 Maven 插件，生成 Swagger 规范的 API 文档：

mvn enunciate:docs

生成的文档可以在 target/docs/swagger 目录下找到。