如何从JAX RS带注释的界面生成标准规格？

Question

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

@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分析器”项目，但是它似乎无法识别我的界面。

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

优选地，该解决方案将仅在Maven构建（插件）中工作。

Answer 1

Swagger在此处为 Jersey 提供了一个易于遵循的教程。

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