如何使用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代碼中的代碼注釋，因此很有可能不是高質量的文檔。 但是嘗試一下。