1.具有無可挑剔的品牌選項(xiàng)的免費(fèi)API文檔工具：ReDoc.ly

我們列表的頂部是 ReDoc。作為幫助團(tuán)隊(duì)使用 OpenAPI 構(gòu)建 API 規(guī)范的咨詢服務(wù)，ReDoc 工具功能強(qiáng)大，同時(shí)支持 OpenAPI v2 和 OpenAPI v3。

那么為什么它是我們的最愛呢?主要是靈活性。事實(shí)上，ReDoc 以四種不同的模式工作：

ReDoc 代碼的托管構(gòu)建： 您只需使用他們提供的 HTML 模板構(gòu)建一個(gè)網(wǎng)頁。這將加載實(shí)現(xiàn)該工具的 JavaScript，您的任務(wù)是為您的 API 規(guī)范指定 URL。

ReactJS 組件：它通過 NPM 包交付，并且很容易集成到 React 項(xiàng)目中。

命令行 (CLI) 工具：您可以運(yùn)行服務(wù)器來生成可瀏覽 API，也可以生成包含可瀏覽 API 的靜態(tài) HTML 文件。

作為 Docker 鏡像：一個(gè)只是打包 ReDoc 服務(wù)器的鏡像。

每種模式都為您提供了自定義可瀏覽文檔的主題選項(xiàng)。這使您可以完全控制顏色、字體選擇、移動響應(yīng)和品牌圖像。

2.Swagger UI ——OpenAPI的直接后代

當(dāng)然，當(dāng) SmartBear 向公眾捐贈 Swagger 規(guī)范時(shí)，Swagger 團(tuán)隊(duì)就是 OpenAPI 的起點(diǎn)。但是，他們?nèi)栽陂_發(fā) Swagger 工具并為商業(yè)活動提供服務(wù)。提供了很多東西，但我們在這里只看 Swagger UI。

雖然 Swagger UI 提供了很好的結(jié)果，但文檔有時(shí)有點(diǎn)混亂。您可以在多種模式下使用它，但并不總是清楚如何實(shí)現(xiàn)每種模式：

一個(gè)獨(dú)立的網(wǎng)頁：可以使用 swagger-ui-dist 包。沒有文檔，但是包有一個(gè) index.html 可以直接使用。這可以用作您網(wǎng)站的示例。

與 Express Web 應(yīng)用程序集成：可以推斷其他 Web 應(yīng)用程序框架。

ReactJS 組件：使用 SwaggerUIBundle。該組件似乎允許插件擴(kuò)展 UI，但文檔不清楚。

一個(gè) Docker 鏡像：提供一個(gè)預(yù)打包的 Swagger UI 服務(wù)器，相對容易使用。

作為通過 Unpkg CDN 的圖像：再次，缺乏文檔。

3.DapperDox –外觀漂亮，但缺乏功能

用于查看 OpenAPI v2 或 v3 規(guī)范的開源項(xiàng)目。它有很多有趣的功能，其中之一就是集成用 Markdown 編寫的文檔。

雖然這是一個(gè)很棒的功能，但 DapperDox 有時(shí)有點(diǎn)挑剔。我們嘗試了幾個(gè) OpenAPI v2 示例，它經(jīng)常給出諸如“錯誤：GET /v1/pets/{petId} 引用沒有標(biāo)題成員的模型定義”之類的錯誤，之后服務(wù)器就會崩潰。我們發(fā)現(xiàn)唯一可以可靠工作的示例是官方 OpenAPI 存儲庫中的簡單 OpenAPI v3 PetStore 演示。

DapperDox 作為從 Go 源代碼為特定操作系統(tǒng)編譯的二進(jìn)制文件提供。 它是一個(gè)命令行工具，用于解析 OpenAPI 規(guī)范，并且是一個(gè)提供文檔的 Web 服務(wù)器。

該DapperDox網(wǎng)站擁有廣泛的文檔區(qū)，這是清晰和易于理解。 除了可瀏覽的 API 規(guī)范和自定義演示之外，它還介紹了構(gòu)建指南。

以上是三款免費(fèi)的API文檔編寫工具，大家如果對Java感興趣，可以關(guān)注一下動力節(jié)點(diǎn)的Java在線學(xué)習(xí)，里面有更多的相關(guān)教程可以在線學(xué)習(xí)，希望對大家能夠有所幫。