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



我有一个集成了Swagger的RESTful API,因此现在可以使用浏览器指向该服务器并查看记录该API的Swagger UI。我想使用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/

最新更新