API在線文檔

API文檔經常使用於幫助項目內成員協做、測試,或提供給用戶參考使用。如何纔可以優雅的分享API文檔,使用工具是一個不錯的選擇。
在線的API文檔工具備不少,例如:Swagger、SosoAPI、Eolinker、Showdoc等,目前工做上使用的是Eolinker。
在Eolinker中,您能夠在線分享項目給團隊之外的人,其餘人能夠經過分享連接在線查看API文檔而且進行API測試。經過這種方式查看API文檔不須要註冊帳號,方便查看接口文檔和測試接口。
進入API管理項目概況頁面,點擊在線分享項目設置,便可啓用或禁用項目在線分享功能。
工具

能夠隨時開啓關閉,分享後,支持不用登陸就能方便地提供給想分享的人查看。若是須要訪問支持設置密碼,能夠按照下圖所示設置:
測試

還能夠設定容許訪客執行的操做:查閱API文檔、進行API測試、查看狀態碼文檔、查看項目文檔等。如:
能夠查看【詳細的API文檔】、【發起API測試】、【查看Mock API】、【查看狀態碼文檔】、【查看項目文檔】,還能夠查看【項目環境】的信息。
3d

查看API文檔:
blog

發起API 測試:
隨時對API發起測試,檢測API
接口

查看mock:
展現各類指望、模擬實際返回數據
圖片

狀態碼文檔:
註明各類返回狀態碼的意思
開發

切換環境:
開啓以後可查看項目環境,訪客能夠在項目分享頁右上方看到環境切換菜單。
設置訪客可以看到的項目環境信息,好比開發環境、測試環境、生產環境等請求地址前綴信息等,默認爲不可切換環境。
文檔

項目文檔:
附帶項目的各類文字描述、圖片、文件等
get

API工具提升了項目的靈活性,選擇合適的API管理工具能夠幫助咱們更好的管理項目流程。
Eolinker:www.eolinker.com登錄

相關文章
相關標籤/搜索