如何在CLI中使用apispark

Question

我如何内省现有的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，至少可以获得部分结果来查看我的资源，但我也希望看到方法，并希望用相应的文档注释我的代码。如何才能做到这一点？如何在restlet资源中使用swagger注解？

Answer 1

自检

您应该访问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。这里描述了处理pets的资源：http://petstore.swagger.wordnik.com/api/api-docs/pet (附加在资源列表中给出的路径)。SwaggerApplication将遵循相同的方案。

在下一个版本或Restlet中会有对Swagger注解的支持，因为我们目前正在研究这个主题，我会在完成后更新这个线程。如果很紧急，你可能会有兴趣看看this page上的最后一条评论。

希望这能帮上忙