Question

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

它似乎可以生成这个客户端SDK，我可以通过Chrome Developer Tools中的功能按对象和功能浏览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代码中的代码注释，因此很可能不是高质量的文档。试试吧。