如何使用swagger-js生成静态HTML文档？

Question

我有一个集成了Swagger的RESTful API，因此现在可以使用浏览器指向该服务器，并查看Swagger UI记录了该API。 我想使用swagger-js项目从服务器上的Swagger数据以Javascript生成客户端SDK。

似乎可以生成此客户端SDK，并且我可以在Chrome开发者工具中按对象和按功能浏览SDK对象。 但是，我想以某种方式为该客户端SDK生成文档，以便用户可以阅读它来查找他们要进行的调用，而无需在浏览器开发环境中进行繁琐的探索。

例如，如果我的客户端SDK是从Swagger数据生成的，并且具有以下方法：

PetStore.addPet(petData)
PetStore.updatePet(petId, petData)
PetStore.deletePet(petId)

我想拥有可供用户阅读以了解这些内容的静态文档。 这可能吗？

Swagger-codegen项目可以切换为以给定语言制作SDK时生成静态HTML文档，但是奇怪的是，它不支持Javascript，而是将其留给了swagger-js项目，后者似乎无法制作静态文档。

Answer 1

看看[1] jsdoc可以为自动生成的javascript客户端SDK生成文档。 本文档的质量取决于javascript代码中的代码注释，因此很有可能不是高质量的文档。 但是尝试一下。