API文檔常用于幫助項(xiàng)目?jī)?nèi)成員協(xié)作、測(cè)試，或提供給用戶參考使用。如何才能夠優(yōu)雅的分享API文檔，使用工具是一個(gè)不錯(cuò)的選擇。 在線的API文檔工具有很多，例如：Swagger、SosoAPI、Eolinker、Showdoc等，目前工作上使用的是Eolinker。 在Eolinker中，您可以在線分享項(xiàng)目給團(tuán)隊(duì)以外的人，其他人可以通過(guò)分享鏈接在線查看API文檔并且進(jìn)行API測(cè)試。通過(guò)這種方式查看API文檔不需要注冊(cè)賬號(hào)，方便查看接口文檔和測(cè)試接口。 進(jìn)入API管理項(xiàng)目概況頁(yè)面，點(diǎn)擊在線分享項(xiàng)目設(shè)置，即可啟用或禁用項(xiàng)目在線分享功能。

可以隨時(shí)開(kāi)啟關(guān)閉，分享后，支持不用登錄就能方便地提供給想分享的人查看。如果需要訪問(wèn)支持設(shè)置密碼，可以按照下圖所示設(shè)置：

還可以設(shè)定允許訪客執(zhí)行的操作：查閱API文檔、進(jìn)行API測(cè)試、查看狀態(tài)碼文檔、查看項(xiàng)目文檔等。如： 可以查看【詳細(xì)的API文檔】、【發(fā)起API測(cè)試】、【查看Mock API】、【查看狀態(tài)碼文檔】、【查看項(xiàng)目文檔】，還可以查看【項(xiàng)目環(huán)境】的信息。

查看API文檔：

發(fā)起API 測(cè)試： 隨時(shí)對(duì)API發(fā)起測(cè)試，檢測(cè)API

查看mock： 展示各種期望、模擬實(shí)際返回?cái)?shù)據(jù)

狀態(tài)碼文檔： 注明各種返回狀態(tài)碼的意思

切換環(huán)境： 開(kāi)啟之后可查看項(xiàng)目環(huán)境，訪客可以在項(xiàng)目分享頁(yè)右上方看到環(huán)境切換菜單。 設(shè)置訪客能夠看到的項(xiàng)目環(huán)境信息，比如開(kāi)發(fā)環(huán)境、測(cè)試環(huán)境、生產(chǎn)環(huán)境等請(qǐng)求地址前綴信息等，默認(rèn)為不可切換環(huán)境。

項(xiàng)目文檔： 附帶項(xiàng)目的各種文字描述、圖片、文件等。

API工具提高了項(xiàng)目的靈活性，選擇合適的API管理工具可以幫助我們更好的管理項(xiàng)目流程。

以上就是關(guān)于“API在線文檔的詳細(xì)介紹”，如果您想了解更多相關(guān)知識(shí)，可以關(guān)注一下動(dòng)力節(jié)點(diǎn)的Java在線學(xué)習(xí)，里面有更多的知識(shí)在等著大家去學(xué)習(xí)，希望對(duì)大家能夠有所幫助。