如何从JAX RS注释接口生成swagger规范？

Question

我想知道是否有一种方法可以从现有的JAX RS注释接口生成swagger规范，例如，是这样的：

@Consumes(MediaType.APPLICATION_JSON) 
@Produces(MediaType.APPLICATION_JSON) 
public interface ISampleService { 

    @GET 
    @Path("sample/foobar/{foobarId}") 
    Foobar getFoobar(@PathParam("foobarId") String foobarId); 

    @PUT 
    @Path("sample/foobar/{foobarId}") 
    Foobar updateFoobar(@PathParam("foobarId") String foobarId, Foobar foobar); 
} 

我没有找到这个"jaxrs analyzer" project，但它似乎并没有认识到我的界面。

基本上，我有我的服务在这样的界面中定义，我想反向工程swagger规范能够发布它，使任何人都可以使用swagger功能生成（其他）客户端。

最好，解决方案只会在maven构建（插件）中工作。

Answer 1

Swagger有一个易于使用的泽西岛here教程。

为了让Swagger为您的资源生成规范，您需要在班级顶部添加@Api注释。可用的注释列出here，但我只是使用@Api。