如何从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为Jersey here提供了一个易于学习的教程。

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