如何从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”的项目（链接），但它似乎无法识别我的接口。

基本上，我将我的服务定义在一个接口中，然后想通过逆向工程Swagger规范来发布它，以便其他人可以使用Swagger功能生成（其他）客户端。

最好的解决方案是可以在Maven构建（插件）中直接使用。

- mac

Answer 1

Swagger为Jersey提供了易于跟随的教程，可以在这里找到。

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

- Paul

---

有没有办法直接告诉Swagger：“嘿，只要类中有javax.ws.rs.Path注解，就是一个Swagger文档，并将其作为API处理？” - Nicholas DiPiazza