如何從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。