API檔案常用于幫助專案內成員協作、測驗,或提供給用戶參考使用,如何才能夠優雅的分享API檔案,使用工具是一個不錯的選擇,
在線的API檔案工具有很多,例如:Swagger、SosoAPI、Eolinker、Showdoc等,目前作業上使用的是Eolinker,
在Eolinker中,您可以在線分享專案給團隊以外的人,其他人可以通過分享鏈接在線查看API檔案并且進行API測驗,通過這種方式查看API檔案不需要注冊賬號,方便查看介面檔案和測驗介面,
進入API管理專案概況頁面,點擊在線分享專案設定,即可啟用或禁用專案在線分享功能,

可以隨時開啟關閉,分享后,支持不用登錄就能方便地提供給想分享的人查看,如果需要訪問支持設定密碼,可以按照下圖所示設定:


還可以設定允許訪客執行的操作:查閱API檔案、進行API測驗、查看狀態碼檔案、查看專案檔案等,如:
可以查看【詳細的API檔案】、【發起API測驗】、【查看Mock API】、【查看狀態碼檔案】、【查看專案檔案】,還可以查看【專案環境】的資訊,

查看API檔案:

發起API 測驗:
隨時對API發起測驗,檢測API

查看mock:
展示各種期望、模擬實際回傳資料

狀態碼檔案:
注明各種回傳狀態碼的意思

切換環境:
開啟之后可查看專案環境,訪客可以在專案分享頁右上方看到環境切換選單,
設定訪客能夠看到的專案環境資訊,比如開發環境、測驗環境、生產環境等請求地址前綴資訊等,默認為不可切換環境,

專案檔案:
附帶專案的各種文字描述、圖片、檔案等

API工具提高了專案的靈活性,選擇合適的API管理工具可以幫助我們更好的管理專案流程,
Eolinker:www.eolinker.com
轉載請註明出處,本文鏈接:https://www.uj5u.com/qita/249735.html
標籤:其他
上一篇:API檔案自動生成的方法
