我有一个集成了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项目,似乎无法制作静态文档 .
1 回答
看一下[1] jsdoc,为自动生成的javascript客户端SDK生成文档 . 此文档的质量取决于JavaScript代码中的代码注释,因此很可能不是高质量的文档 . 但试试吧 .
[1] http://usejsdoc.org/