我想知道是否有一种方法可以从现有的带有JAX RS注释的接口(interface)中生成标准规范。像这样的东西:
@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,但似乎无法识别我的界面。
基本上,我在这样的接口(interface)中定义了我的服务,并且我想对swagger规范进行反向工程以便能够发布它,以便其他任何人都可以使用swagger功能生成(其他)客户端。
优选地,该解决方案将仅在Maven构建(插件)中工作。
最佳答案
Swagger有一个针对Jersey here的易于遵循的教程。
为了使Swagger为您的资源生成规范,您需要在类的顶部添加@Api
批注。可用的注释已列出here,但我只使用@Api
。