1.Slate

Slate是一款出色的工具，可幫助您創(chuàng)建響應(yīng)式、智能且美觀的API文檔。它具有簡潔直觀的設(shè)計，并從 PayPal 和 Stripe 的 API 文檔中汲取靈感。它在左側(cè)組織文檔，而在右側(cè)編碼示例，這在智能手機(jī)、平板電腦和印刷品上看起來非常酷且可讀。

使用 Slate，您不必在無休止的頁面中搜索信息，因為它將所有內(nèi)容都放在一個頁面上，而不會犧牲可鏈接性。鏈接到文檔中的特定點永遠(yuǎn)不會有壓力，因為當(dāng)有人滾動時，哈希會更新到最近的標(biāo)題。

這里寫的一切都在 Markdown 中，包括代碼塊，使您更容易編輯和更清楚地理解事物。Slate 允許您用不同的語言編寫代碼并在代碼塊的頂部指定其名稱。

Slate 允許以 100 多種語言突出顯示獨特的語法，而無需對其進(jìn)行配置。它可以讓您建立一個可平滑滾動的自動目錄，您可以將其添加到頁面的最左側(cè)。Slate 的性能也非常適合大型文檔。

Slate 生成的 API 文檔默認(rèn)托管在 GitHub 中。這意味著您可以使用 GitHub 頁面免費托管整個文檔。

Slate 還為阿拉伯語、希伯來語、波斯語等語言提供 RTL(從右到左)支持。按綠色按鈕 - “使用此模板”，然后按照給定的說明操作，即可輕松開始使用 Slate。

2.NelmioApiDocBundle

使用NelmioApiDocBundle為 API 生成看起來不錯的文檔。該包支持 PHP、Twig、CSS 等語言。NelmioApiDocBundle 允許您以 OpenAPI 格式的版本 2 為您的 API 生成文檔，并提供一個沙箱來與您的 API 進(jìn)行交互實驗。

該包支持 PHP 注釋、Swagger-PHP 注釋、Symfony 路由需求和 FOSRestBundle 注釋。對于模型，NelmioApiDocBundle 支持 JMS 序列化器、Symfony 序列化器、willdurand/Hateoas 庫和 Symfony 形式。

3.Swagger

如果您身邊有Swagger，請忘記手動 API 文檔。它提供了廣泛的令人印象深刻的解決方案，用于創(chuàng)建和可視化您的 API 文檔以及維護(hù)它們，以便它們隨著 API 的發(fā)展而保持最新狀態(tài)。

您可以從 API 定義自動生成文檔。如果您當(dāng)前的 API 不包含定義，它們會提供開源 Swagger Inflector，因此您甚至可以在運(yùn)行時生成 OpenAPI 定義。為了加快整個過程，您可以使用 Swagger Inspector 自動為端點創(chuàng)建 OpenAPI 文件。

您可以使用 SwaggerHub 的版本控制系統(tǒng)維護(hù)文檔的多個版本。

根據(jù)標(biāo)準(zhǔn)規(guī)范擴(kuò)展 API 設(shè)計和建模，并以您想要的任何語言為 API 構(gòu)建可重用且穩(wěn)定的代碼。借助 Swagger，您可以使用他們的交互式文檔流程增強(qiáng)開發(fā)人員體驗，無開銷地執(zhí)行功能測試，并為 API 架構(gòu)設(shè)置和實施樣式指南。

3.自述文件

自述文件提供了一種簡單的方法來生成和管理交互式和精美的 API 文檔。您可以輕松地直接將 API 密鑰合并到文檔中，自動生成代碼示例，并進(jìn)行實際的 APU 調(diào)用而不會混淆。

通過回答您在他們的支持論壇中看到的問題來建立一個強(qiáng)大的社區(qū)，允許消費者提出一些編輯建議，并使每個人都了解更改。使用編輯器同步 Swagger 文件、合并建議的編輯并更新內(nèi)容，以確保您的文檔始終得到更新。

自述文件允許您拖放內(nèi)容;您還可以通過 CSS 自定義所有內(nèi)容。Markdown Editor、Swagger File Import 和 Theme Builder 是人們喜歡 ReadMe 的眾多功能中的一部分。

它甚至允許用戶進(jìn)行 API 調(diào)用，然后復(fù)制粘貼實際的代碼示例。此外，API 日志、API 定義、API Playground 和動態(tài)代碼片段還有一些其他內(nèi)容，它們允許您制作參考指南。

自述文件使與您的團(tuán)隊的協(xié)作更具互動性，因為他們可以使用版本控制快速建議編輯以保持事物整潔。通過論壇式支持收集客戶反饋并認(rèn)真對待，從而提供出色的客戶支持。

5.Widdershins

Widdershins可幫助您根據(jù) OpenAPI 3.0、Semoasa、Swagger 2.0 和 AsyncAPI 1.x 定義創(chuàng)建文檔。最新版本中引入了一些更改，包括“承諾”而不是回調(diào)，以及直接輸出 HTML 和 ReSpec 格式的選項。

Widdershins 使用模板來創(chuàng)建 Markdown 輸出，您可以自定義這些模板或?qū)⑺鼈儚?fù)制到特定文件夾。

6.Postman

如果您聽說過API，您可能沒有聽說過 Postman 。

Postman的 API 文檔是一個不錯的選擇，您可以生成即使是機(jī)器也能很好閱讀的文檔。每次實時更改時，它還可以自動使您的 API 保持最新狀態(tài)，并讓您輕松快速地發(fā)布文檔。

Postman 可以自動提取您的整個示例請求、代碼片段、標(biāo)題等，以使用機(jī)器可讀的指令和動態(tài)示例填充文檔。因此，與您想要的任何人共享 API 變得很容易。

通過在您的文檔或網(wǎng)站中嵌入按鈕“在 Postman 中運(yùn)行”，可在幾秒鐘內(nèi)分享您的所有收藏。這樣，任何人都可以通過單擊導(dǎo)入文檔。通過讓您的文檔可供任何人使用，包括開發(fā)人員、產(chǎn)品經(jīng)理、測試人員等，從而更廣泛地采用 API。

API文檔生成工具是大家需要了解，在動力節(jié)點Java開發(fā)工具中還有很多工具的介紹，大家感興趣的話可以去關(guān)注一下。