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

How to generate static HTML documentation with swagger-js?

我有一个集成了 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项目似乎没有办法制作静态文档。

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

[1] http://usejsdoc.org/