API管理工具介紹——Apifox使用詳解

目錄

如何優雅地進行API管理

最終的解決方案

此外

---

敏捷迭代和團隊協作，前后端分離的工作模式幾乎是每個互聯網公司的常規工作模式。

前后端分離，各自開發的優點很多，其中一項是它只需要提供一個統一的API接口，即可被web，iOS，Android等多個客戶端使用，效率大大提高。

但生于敏捷，死于迭代，困于團隊協作常常是這種軟件研發模式的一大弊病。 隨著項目不斷推進、變更，項目越來越大，維護成本也越來越高。

由于某些公司接口文檔管理方式采用wiki及html，openapi形式，版本迭代較快，接口常常變更，成員間update和文檔維護卻常常跟不上。

在API管理方面越到后期越存在著可觀且隱形的“人力資源”浪費：

1)文檔老舊不可用，新人上手工作、熟悉項目靠“老人”的口口相傳，造成人力雙重浪費，團隊成員自己的工作進度受阻，新人勝任任務的進度緩慢。
2)接口由于初期設計問題/功能擴展/需求變更問題而修改，但修改后往往難以及時同步到前端和測試等下游環節
3）接口在設計初期不規范，造成前端，測試在調試和測試理解上的困難，甚至部分接口需要重新返工

?Python自動化測試學習交流群：全套自動化測試面試簡歷學習資料獲取點擊鏈接加入群聊【python自動化測試交流】：http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=DhOSZDNS-qzT5QKbFQMsfJ7DsrFfKpOF&authKey=eBt%2BF%2FBK81lVLcsLKaFqnvDAVA8IdNsGC7J0YV73w8V%2FJpdbby66r7vJ1rsPIifg&noverify=0&group_code=198408628

?

這些情況越到項目發展后期會越嚴重。以至于不少研發人員總是抱怨：寫代碼不累，溝通對接心累；工作不辛苦，就是命苦。

如何優雅地進行API管理

為了解決研發人員的問題，我們需要解決API管理中的各個痛點，換言之，一個完美的API管理工具應滿足如下特征：

**在接口設計階段，能規范研發人員的接口設計

在接口調試階段，提供多種功能充分調試，高度仿真實際工作情境

在接口維護過程中，維護成本低，且各項變更能及時update到下游工作環節的團隊同事

一站式服務，一個工具就可完成接口的設計、調試、維護，測試過程，不需要反復導入導出，各個軟件來回切換，提高效率。**

最終的解決方案

筆者在網上找了很長時間，發現一款幾乎能滿足以上需求的解決方案軟件--Apifox. 這個軟件的主要特性：

• 可視化接口設計界面，支持 https 和 https 協議，遵循openApi和 Json Schema規范，各項http請求參數與接口描述直接填寫即可。支持構建數據模型，可供多個請求參數復用。

• 媲美postman的接口調試功能，除此之外，還支持“零配置”mock高度仿真的業務數據，支持讀取數據庫

• 系統自動生成代碼根據接口及數據數據模型定義，系統自動生成接口請求代碼、前端業務代碼及后端業務代碼

• 實時更新云端變更的數據到各個團隊成員，避免數據不一致導致的重復工作和返工；代碼更新和文檔更新在同一軟件全部完成，減少維護工作量

• 項目管理為不同的項目角色分配不同執行權限，有效保護項目數據安全;支持openapi，postman格式的舊有項目導入apifox，實現項目無痛遷移，支持html格式，openapi等多種格式的接口數據導出。

接下來筆者再針對一些功能進行詳細的介紹

接口設計

界面可視化，可以對接口信息進行編輯管理，get，post等常規的接口請求方法直接下拉框選擇； query，body，header參數直接對應填寫，返回參數支持JSON,XML格式導入，并能直接進行格式校驗。 接口描述部分支持Markdown格式的文本。

2.接口調試
接口調試有兩種模式，一種是不需要創建項目的快捷調試，直接校驗接口請求 和返回參數， 一種是在項目里對單個接口調試， 這部分的功能基本等同于postman。 可添加多種前后置操作：

校驗返回response，檢查返回狀態和數據結構是否符合預期。

?Python自動化測試學習交流群：全套自動化測試面試簡歷學習資料獲取點擊鏈接加入群聊【python自動化測試交流】：http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=DhOSZDNS-qzT5QKbFQMsfJ7DsrFfKpOF&authKey=eBt%2BF%2FBK81lVLcsLKaFqnvDAVA8IdNsGC7J0YV73w8V%2FJpdbby66r7vJ1rsPIifg&noverify=0&group_code=198408628

3.接口維護當變更接口時直接在apifox內修改并生成新代碼，同時說明文檔就存放在同一個位置，順手修改文檔說明就變得非常方便。接口變更之后，協作成員能及時同步云端變更。

4.項目管理支持數據導入導出，自動生成接口代碼

針對不同角色的成員，設置不同的數據權限。如后端研發可以修改接口數據，而前端和測試成員只有只讀權限，項目外人員則只有訪客權限只能查看到接口信息而無法查看數據類型。

可針對開發調試，測試驗證，線上使用配置不同的服務器：

此外

Apifox不僅是一款針對研發人員的API管理工具，還能為測試人員提供接口測試，接口自動化測試，測試管理等一系列功能?？梢哉f是一款研發團隊一站式提升效率的神器。

?Python自動化測試學習交流群：全套自動化測試面試簡歷學習資料獲取點擊鏈接加入群聊【python自動化測試交流】：http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=DhOSZDNS-qzT5QKbFQMsfJ7DsrFfKpOF&authKey=eBt%2BF%2FBK81lVLcsLKaFqnvDAVA8IdNsGC7J0YV73w8V%2FJpdbby66r7vJ1rsPIifg&noverify=0&group_code=198408628

總結：

感謝每一個認真閱讀我文章的人！！！

我個人整理了我這幾年軟件測試生涯整理的一些技術資料，包含：電子書，簡歷模塊，各種工作模板，面試寶典，自學項目等。歡迎大家點擊下方名片免費領取，千萬不要錯過哦。

? ? ? ? ??

?