java - 如何从 CLI 使用 apispark

Question

如何内省(introspection)现有 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 并且至少可以获得部分结果来查看我的资源，但我还想查看这些方法，并希望使用相应的文档来注释我的代码。如何才能实现这一目标？如何将 swagger 注释与 ReSTLet 资源一起使用？

Answer 1

自省(introspection)

您应该访问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 上的最新评论.

希望这有帮助，