目錄

Apifox簡(jiǎn)介

Apifox的安裝與使用

Apifox新建項(xiàng)目的流程

編寫接口文檔

---

Apifox簡(jiǎn)介

我們?cè)谌粘＞幊涕_發(fā)過程中經(jīng)常實(shí)行的是前后端分離架構(gòu)的模式，一個(gè)項(xiàng)目的落地會(huì)通過產(chǎn)品、開發(fā)、測(cè)試三方會(huì)審，對(duì)項(xiàng)目需求評(píng)審過后，前后端開發(fā)會(huì)制定一些接口，他們通常會(huì)用以下方式：

開發(fā)指定接口文檔（Reg）。

后端開發(fā)依據(jù)接口文檔開發(fā)接口，一邊開發(fā)一邊測(cè)試（Postman）。

前端開發(fā)需要（Mock）數(shù)據(jù)供前端調(diào)用。

開發(fā)完成后，測(cè)試通過（Postman，Jmeter）去進(jìn)行接口測(cè)試。

為了能讓各個(gè)產(chǎn)品項(xiàng)目負(fù)責(zé)人落地更加便捷，Apifox應(yīng)運(yùn)而生實(shí)現(xiàn)了API設(shè)計(jì)開發(fā)測(cè)試一體化協(xié)作。俗稱：Apifox=Postman+Swagger+Jmeter+Mock工具集。簡(jiǎn)而言之：開發(fā)人員在Apifox里定接口、前端直接根據(jù)Apifox去Mock數(shù)據(jù)、后端開發(fā)直接在Apifox進(jìn)行調(diào)試、測(cè)試人員直接在Apifox的接口文檔里面寫用例、接下來就是前后端進(jìn)行聯(lián)調(diào)。

Apifox的安裝與使用

安裝的話就很簡(jiǎn)單了，百度搜索 Apifox ，或點(diǎn)擊右側(cè)的網(wǎng)址 Apifox網(wǎng)址 ，進(jìn)入網(wǎng)址選擇自己電腦適配的系統(tǒng)以及需求進(jìn)行選擇使用。

這邊我電腦是 win64 ，所有這邊我下載了桌面版64位，下載完成傻瓜式安裝即可。安裝完成進(jìn)行注冊(cè)登錄，登錄完成你會(huì)看到界面有一個(gè)個(gè)人項(xiàng)目，里面有一個(gè)項(xiàng)目案例給你簡(jiǎn)單介紹一下這個(gè)根據(jù)的簡(jiǎn)單使用。

給你一個(gè)簡(jiǎn)單的案例，呈現(xiàn)頁(yè)面會(huì)出現(xiàn)哪些信息，讓你初步了解一下。

對(duì)于頁(yè)面的風(fēng)格自己也可以進(jìn)行設(shè)置， 打開設(shè)置對(duì)頁(yè)面的主題顏色和字體大小可以自定義，還有一些其他的網(wǎng)絡(luò)代理、證書代理調(diào)配等。

Apifox新建項(xiàng)目的流程

點(diǎn)擊新建團(tuán)隊(duì)，創(chuàng)建新項(xiàng)目。

輸入自己的團(tuán)隊(duì)名稱，點(diǎn)擊保存。

進(jìn)入自己保存的團(tuán)隊(duì)：可以新建項(xiàng)目、可以定向邀請(qǐng)成員協(xié)同操作、可以修改團(tuán)隊(duì)名稱移交或解散團(tuán)隊(duì)。

接下來新建項(xiàng)目，輸入名稱，項(xiàng)目圖標(biāo)自定，如果第一次使用可以允許包含示例數(shù)據(jù)，因?yàn)槲疫@里沒有定向邀請(qǐng)其他成員，項(xiàng)目中就只有我一個(gè)人，點(diǎn)擊確認(rèn)即可。

點(diǎn)擊確認(rèn)之后跳轉(zhuǎn)到如下界面，因?yàn)樯厦嫖彝獍纠龜?shù)據(jù)，所有在項(xiàng)目概覽中的項(xiàng)目統(tǒng)計(jì)上數(shù)字不為0， 當(dāng)前的項(xiàng)目可進(jìn)行的操作很多，如下：

編寫接口文檔

基本信息填寫

點(diǎn)擊新建接口，進(jìn)行編寫接口文檔。

因?yàn)楸救朔?wù)器停運(yùn)，這里借助黑馬程序員某位老師的接口進(jìn)行展示(doge)，這里填寫最基本的信息。

確認(rèn)信息無誤后點(diǎn)擊保存即可。

params參數(shù)設(shè)置

params參數(shù)有兩種方式，一種是 url后面?之后的參數(shù)；另一種是 url中的{參數(shù)名}參數(shù)。

Body參數(shù)

Body參數(shù)可以根據(jù)自己的需求上傳不同格式的文件信息。

這里借用上文提到的接口簡(jiǎn)單的演示一下，轉(zhuǎn)成json格式的數(shù)據(jù)是什么樣的。這個(gè)工具會(huì)將我們的數(shù)據(jù)自動(dòng)解析并識(shí)別成json格式。

我們可以將自己接口上的list添加一下新的東西來驗(yàn)證返回成功的200數(shù)據(jù)，如下：

將響應(yīng)成功的案例自動(dòng)生成在下面：

為了方便區(qū)別自己的接口是否成功寫入，可以寫入一個(gè)錯(cuò)誤的響應(yīng)以及案例來進(jìn)行區(qū)別，可以將錯(cuò)誤的響應(yīng)里面的內(nèi)容刪除一點(diǎn)，并根據(jù)錯(cuò)誤的響應(yīng)生成一個(gè)異常示例：

修改文檔完成點(diǎn)擊保存并點(diǎn)擊運(yùn)行進(jìn)入運(yùn)行頁(yè)面，點(diǎn)擊自動(dòng)生成的數(shù)據(jù)，點(diǎn)擊發(fā)送即可

沒有問題點(diǎn)擊保存為用例

也可以設(shè)置特殊情況，來保存成為錯(cuò)誤的用例

也可以給測(cè)試的數(shù)據(jù)添加一些動(dòng)態(tài)值來更好的處理一些情況

后置操作獲取token值

我們?cè)谶M(jìn)行登錄接口的測(cè)試時(shí)，可以通過后置操作獲取其相應(yīng)的token值，其操作和上文一樣，編寫相應(yīng)的接口文檔

通過后置操作獲取其token值

Apifox的其他功能：

環(huán)境變量、全局變量、臨時(shí)變量、動(dòng)態(tài)變量、隨機(jī)參數(shù)、自動(dòng)化字段、socket接口、團(tuán)隊(duì)管理、導(dǎo)入導(dǎo)出、MOCK、腳本開發(fā)、自動(dòng)化執(zhí)行、Jenkins持續(xù)集成等

總結(jié)：

總的來說，Apifox這個(gè)工具的功能性還是很強(qiáng)大的，很多企業(yè)也開始使用這個(gè)工具，對(duì)于程序員來說，不善于接觸新事物對(duì)自身的發(fā)展是不利的，這篇文章主要介紹了這個(gè)工具的基本使用，還有很多強(qiáng)大的功能沒有在此體現(xiàn)出來，還是需要各位在工作中慢慢發(fā)掘。

總結(jié)

以上是生活随笔為你收集整理的Apifox：详细使用教程，带你轻松拿捏的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。