1.具有無可挑剔的品牌選項的免費API文檔工具：ReDoc.ly

我們列表的頂部是 ReDoc。作為幫助團隊使用 OpenAPI 構建 API 規范的咨詢服務，ReDoc 工具功能強大，同時支持 OpenAPI v2 和 OpenAPI v3。

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

ReDoc 代碼的托管構建： 您只需使用他們提供的 HTML 模板構建一個網頁。這將加載實現該工具的 JavaScript，您的任務是為您的 API 規范指定 URL。

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

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

作為 Docker 鏡像：一個只是打包 ReDoc 服務器的鏡像。

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

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

當然，當 SmartBear 向公眾捐贈 Swagger 規范時，Swagger 團隊就是 OpenAPI 的起點。但是，他們仍在開發 Swagger 工具并為商業活動提供服務。提供了很多東西，但我們在這里只看 Swagger UI。

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

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

與 Express Web 應用程序集成：可以推斷其他 Web 應用程序框架。

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

一個 Docker 鏡像：提供一個預打包的 Swagger UI 服務器，相對容易使用。

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

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

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

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

DapperDox 作為從 Go 源代碼為特定操作系統編譯的二進制文件提供。 它是一個命令行工具，用于解析 OpenAPI 規范，并且是一個提供文檔的 Web 服務器。

該DapperDox網站擁有廣泛的文檔區，這是清晰和易于理解。 除了可瀏覽的 API 規范和自定義演示之外，它還介紹了構建指南。

以上是三款免費的API文檔編寫工具，大家如果對Java感興趣，可以關注一下動力節點的Java在線學習，里面有更多的相關教程可以在線學習，希望對大家能夠有所幫。