如何在 MarkLogic REST API 上使用 swagger/openAPI 来生成文档?

How to use swagger/openAPI on MarkLogic REST APIs for generating documentation?

我有一堆用 SJS 编写的 REST API(GET/POST 方法),我想使用 swagger/openAPI 来记录它。我找到了一个包含一些代码的 GitHub 回购协议,但不确定如何 run/use 它与我的项目。

Link: https://github.com/overstory/marklogic-swagger

PS:我选择的IDE是intelliJ。

请告知相同的步骤。谢谢!

我不知道可以分析 REST 端点并为其生成 Swagger 或 OpenAPI 的工具。 AFAIK,也没有工具可以从 MarkLogic REST 扩展或自定义 MarkLogic REST 实现中生成任何此类内容。很难编写一个能够做到这一点的通用工具。恐怕您将不得不手动输入它,或者自己编写一些脚本来生成对您的案例有用的东西。

HTH!