如何从CLI使用apispark

时间:2014-10-10 14:44:54

标签: java restlet swagger

如何为现有的restlet服务器内省其资源?

我是这样开始的,总是遇到错误:

java -cp lib/org.restlet.ext.apispark.jar:lib/org.restlet.jar:dist/myrestapi.jar org.restlet.ext.apispark.Introspector -l swagger -v com.example.service.MyRestService -u xxx -p yyy

我是否需要注释我的服务器资源以及如何实现它以便列出我的资源和操作?

我还尝试扩展SwaggerApplication并且至少可以得到部分结果来查看我的资源,但我也想查看这些方法,并希望使用相应的文档来注释我的代码。怎么能实现这一目标?如何使用swlet注释和restlet资源?

1 个答案:

答案 0 :(得分:2)

<强>反思

您应该访问this page以获得正确的依赖项(有些缺失)和语法。 在你的情况下,我尝试这样的事情:

java -cp lib/*:dist/myrestapi.jar org.restlet.ext.apispark.Introspector -v -u xxx -p yyy com.example.service.MyRestService

注意: Introspector目前正在进行大量重构,您无法将定义上传到APISpark。当服务重新开始营业时,我会及时通知您。

<强> SwaggerApplication

SwaggerApplication将在/ api-docs上提供Swagger资源列表,在/ api-docs / {pathToApiDeclaration}上提供API声明。您应该能够在第二类路径上看到方法。

有关在线示例,请检查http://petstore.swagger.wordnik.com/api/api-docs。这里描述了处理宠物的资源:http://petstore.swagger.wordnik.com/api/api-docs/pet(附加资源清单中给出的路径)。 SwaggerApplication将遵循相同的方案。

我们正在研究这个主题,在下一个版本或Restlet中将支持Swagger注释,一旦完成,我将更新此线程。如果紧急,您可能有兴趣查看this page上的最新评论。

希望这有帮助,