Apifox:详细使用教程,带你轻松拿捏
目錄
Apifox簡介
Apifox的安裝與使用
Apifox新建項目的流程
編寫接口文檔
Apifox簡介
我們在日常編程開發過程中經常實行的是前后端分離架構的模式,一個項目的落地會通過產品、開發、測試三方會審,對項目需求評審過后,前后端開發會制定一些接口,他們通常會用以下方式:
開發指定接口文檔(Reg)。
后端開發依據接口文檔開發接口,一邊開發一邊測試(Postman)。
前端開發需要(Mock)數據供前端調用。
開發完成后,測試通過(Postman,Jmeter)去進行接口測試。
為了能讓各個產品項目負責人落地更加便捷,Apifox應運而生實現了API設計開發測試一體化協作。俗稱:Apifox=Postman+Swagger+Jmeter+Mock工具集。簡而言之:開發人員在Apifox里定接口、前端直接根據Apifox去Mock數據、后端開發直接在Apifox進行調試、測試人員直接在Apifox的接口文檔里面寫用例、接下來就是前后端進行聯調。
Apifox的安裝與使用
安裝的話就很簡單了,百度搜索 Apifox ,或點擊右側的網址 Apifox網址 ,進入網址選擇自己電腦適配的系統以及需求進行選擇使用。
這邊我電腦是 win64 ,所有這邊我下載了桌面版64位,下載完成傻瓜式安裝即可。安裝完成進行注冊登錄,登錄完成你會看到界面有一個個人項目,里面有一個項目案例給你簡單介紹一下這個根據的簡單使用。
給你一個簡單的案例,呈現頁面會出現哪些信息,讓你初步了解一下。
對于頁面的風格自己也可以進行設置, 打開設置對頁面的主題顏色和字體大小可以自定義,還有一些其他的網絡代理、證書代理調配等。
Apifox新建項目的流程
點擊新建團隊,創建新項目。
輸入自己的團隊名稱,點擊保存。
進入自己保存的團隊:可以新建項目、可以定向邀請成員協同操作、可以修改團隊名稱移交或解散團隊。
接下來新建項目,輸入名稱,項目圖標自定,如果第一次使用可以允許包含示例數據,因為我這里沒有定向邀請其他成員,項目中就只有我一個人,點擊確認即可。
點擊確認之后跳轉到如下界面,因為上面我同意包含示例數據,所有在項目概覽中的項目統計上數字不為0, 當前的項目可進行的操作很多,如下:
編寫接口文檔
基本信息填寫
點擊新建接口,進行編寫接口文檔。
因為本人服務器停運,這里借助黑馬程序員某位老師的接口進行展示(doge),這里填寫最基本的信息。
確認信息無誤后點擊保存即可。
params參數設置
params參數有兩種方式,一種是 url后面?之后的參數;另一種是 url中的{參數名}參數。
Body參數
Body參數可以根據自己的需求上傳不同格式的文件信息。
這里借用上文提到的接口簡單的演示一下,轉成json格式的數據是什么樣的。這個工具會將我們的數據自動解析并識別成json格式。
我們可以將自己接口上的list添加一下新的東西來驗證返回成功的200數據,如下:
將響應成功的案例自動生成在下面:
為了方便區別自己的接口是否成功寫入,可以寫入一個錯誤的響應以及案例來進行區別,可以將錯誤的響應里面的內容刪除一點,并根據錯誤的響應生成一個異常示例:
修改文檔完成點擊保存并點擊運行進入運行頁面,點擊自動生成的數據,點擊發送即可
沒有問題點擊保存為用例
也可以設置特殊情況,來保存成為錯誤的用例
也可以給測試的數據添加一些動態值來更好的處理一些情況
后置操作獲取token值
我們在進行登錄接口的測試時,可以通過后置操作獲取其相應的token值,其操作和上文一樣,編寫相應的接口文檔
通過后置操作獲取其token值
Apifox的其他功能:
環境變量、全局變量、臨時變量、動態變量、隨機參數、自動化字段、socket接口、團隊管理、導入導出、MOCK、腳本開發、自動化執行、Jenkins持續集成等
總結:
總的來說,Apifox這個工具的功能性還是很強大的,很多企業也開始使用這個工具,對于程序員來說,不善于接觸新事物對自身的發展是不利的,這篇文章主要介紹了這個工具的基本使用,還有很多強大的功能沒有在此體現出來,還是需要各位在工作中慢慢發掘。
總結
以上是生活随笔為你收集整理的Apifox:详细使用教程,带你轻松拿捏的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 关于销售订单高级定价的一点疑惑
- 下一篇: 伊朗 2018 ICPC区域赛 A :