大家好，我是路飛！今天這篇文章，給大家介紹一款非常好用的國內(nèi)軟件自研發(fā)的開發(fā)輔助軟件 ApiPost！

作為一個名服務(wù)端開發(fā)者，我們在日常工作中離不開接口測試、接口文檔編寫、Mock 數(shù)據(jù)測試、前后端接口聯(lián)調(diào)。為了完成這些任務(wù)，我們經(jīng)常需要用到 Postman、Swagger、Mock Js等等，而今天這款軟件是恰好包含了這三者所有的功能，以及額外的擴展功能！

ApiPost = Postman + Swagger + Mock

一、什么是ApiPost？

1、介紹

• 官網(wǎng)地址：apipost.cn

ApiPost是一款將接口調(diào)試+接口文檔快速生成+接口文檔規(guī)范化管理+Mock API+接口流程測試集成一體的輔助開發(fā)軟件。

ApiPost產(chǎn)生的初衷是為了提高研發(fā)團隊各個角色的效率！產(chǎn)品的使用受眾為由前端開發(fā)、后端開發(fā)和測試人員以及技術(shù)經(jīng)理組成的整個研發(fā)技術(shù)團隊。

2、面向的用戶群體

• 前端開發(fā)人員：支持接口文檔預覽、接口Mock數(shù)據(jù)、接口調(diào)試、前端代碼自動生成。
• 后端開發(fā)人員：支持接口文檔自動生成、支持接口文檔測試調(diào)用。
• 測試開發(fā)人員：支持接口調(diào)試、接口自動化測試。
• 研發(fā)經(jīng)理：規(guī)范接口文檔管理、提升整體研發(fā)團隊效率。

二、ApiPost下載與安裝

1、下載

• 下載地址：https://www.apipost.cn/download.html

選擇合適自己電腦操作系統(tǒng)的安裝包下載即可，這里我簡單演示一下Mac和Windows電腦上的安裝流程。

2、安裝

2.1、Mac上安裝

我的辦公電腦是M1芯片的MacOS系統(tǒng)，所以這里選擇下載 Mac 客戶端（arm64，適配M1芯片） 。dmg結(jié)尾的安裝包下載完畢后，直接雙擊運行即可安裝：

2.2、Windows上安裝

Windows電腦上我選擇 Window 64位 客戶端 ，下載完畢后直接運行exe文件即可。



安裝完成后，我們來簡單實操一下ApiPost的一些常用功能！

三、ApiPosts實操

• 官方幫助文檔：APIPOST 使用文檔

1、HTTP請求接口（獲取天氣預報信息）

ApiPost在測試請求接口時，和Postman一樣，主要注意下面幾個部分的參數(shù)配置即可：

• Header 參數(shù)：可以設(shè)置或者導入 Header 參數(shù)，cookie也在Header進行設(shè)置。
• Query 參數(shù)：Query 支持構(gòu)造URL參數(shù)，同時支持 RESTful 的 PATH 參數(shù)（如:id）。
• Body 參數(shù)：Body 提供三種類型 form-data / x-www-form-urlencoded / raw ，每種類型提供三種不同的UI界面。這三者分別對應(yīng)提交表單參數(shù)、提交有文件的表單參數(shù)、發(fā)送JSON對象或者其他對象。

這里簡單測試一下查詢所在城市天氣信息的天氣預報接口調(diào)用：

http://apis.juhe.cn/simpleWeather/query?city=杭州&key=351e0xxxxxxxxxxxxxx8b266

• 1

完整的請求結(jié)果如下：

{"reason": "查詢成功!","result": {"city": "杭州","realtime": {"temperature": "14","humidity": "55","info": "晴","wid": "00","direct": "東風","power": "3級","aqi": "140"},"future": [{"date": "2022-02-27","temperature": "8/14℃","weather": "晴轉(zhuǎn)多云","wid": {"day": "00","night": "01"},"direct": "東風轉(zhuǎn)持續(xù)無風向"},{"date": "2022-02-28","temperature": "9/20℃","weather": "多云轉(zhuǎn)小雨","wid": {"day": "01","night": "07"},"direct": "持續(xù)無風向轉(zhuǎn)西北風"},{"date": "2022-03-01","temperature": "7/15℃","weather": "小雨","wid": {"day": "07","night": "07"},"direct": "西北風轉(zhuǎn)持續(xù)無風向"},{"date": "2022-03-02","temperature": "7/17℃","weather": "晴轉(zhuǎn)陰","wid": {"day": "00","night": "02"},"direct": "持續(xù)無風向"},{"date": "2022-03-03","temperature": "8/14℃","weather": "小雨轉(zhuǎn)小到中雨","wid": {"day": "07","night": "21"},"direct": "持續(xù)無風向"}]},"error_code": 0 } 2、使用ApiPost發(fā)送請求給自己的博客文章點贊

操作步驟：

• 1、點贊請求URL：https://blog.csdn.net//phoenix/web/v1/article/like
• 2、請求類型：POST
• 3、設(shè)置Cookie：在文章列表頁F12打開控制臺，拷貝請求Cookie信息。
• 3、Body請求參數(shù)：articleId: 122262651

從上面兩個案例，可以看到，ApiPost在接口測試、接口調(diào)用方面相比于純英的Postman，對國內(nèi)開發(fā)者友好很多，而且在一些使用細節(jié)上既保留了Postman原有開發(fā)者用戶的操作習慣，還在原來基礎(chǔ)上增加了很多新的功能。

那么，ApiPost就只是一個增強版的Postman嗎？

肯定不是呀，下面我們來康康使用ApiPost如何快速一鍵生成接口文檔！

3、一鍵生成接口文檔

我們知道，在前后端協(xié)作開發(fā)時，接口文檔是必須要的。而接口文檔的編寫任務(wù)往往交給后端同學去負責，需要給出接口的各種參數(shù)要求以及參考實例等等，非常繁瑣。

為了前后端協(xié)作便利，很多公司使用 Swagger 作為接口文檔生成工具，嵌套在后端服務(wù)中，當后端開發(fā)著完成后端接口編寫，就可以自動生成接口文檔。

但是 Swagger 需要在后端模塊添加額外的 Swagger 集成代碼。而 ApiPost 剛好可以把 Swagger 和 Postman 二者的功能合二為一，對開發(fā)者帶來極大的便利性！如下圖所示：

點擊分享文檔/分享項目查看自動生成的接口文檔：

文檔如下所示：

4、Mock

ApiPost 可以讓前端開發(fā)者在沒有后端程序的情況下能真實地返回接口數(shù)據(jù)，可以用 ApiPost 實現(xiàn)項目初期純前端的效果演示，也可以用 ApiPost 實現(xiàn)開發(fā)中的數(shù)據(jù)模擬從而實現(xiàn)前后端分離。

• 官方文檔：ApiPost中使用Mock

編寫mock規(guī)則：

Mock 規(guī)則模板支持類型豐富（5.4版本起）。

• 基本數(shù)據(jù)(固定json結(jié)構(gòu))

{"code": "0","data": {"name": "張三豐","age": 100},"desc": "成功" }

• 基本數(shù)據(jù)(Mock隨機json結(jié)構(gòu))

{"code": "0","data": {"list|20": [{"name": "@name","age": "@integer(2)"}],"url": "https://echo.apipost.cn"},"desc": "成功" }

如圖所示：

將生成的mock URL地址發(fā)給前端：

這樣前端就可以使用您模擬的數(shù)據(jù)進行先一步的調(diào)試開發(fā)了。當您的接口完成后，再替換回來即可。

注：APIPOST的 mock 是基于mock.js 開發(fā)的。具體文檔可以 參見 mock.js 詳細文檔。

5、全局參數(shù)和目錄參數(shù)設(shè)置

5.1、全局參數(shù)

在實際項目中，對于一批接口，往往具有相同的請求參數(shù)。此時，我們可以利用全局參數(shù)或者目錄參數(shù)實現(xiàn)。

例如：常見的token令牌參數(shù)，假使我們請求項目下的任何接口都需要在header帶上token參數(shù)，那么我們當然可以每個接口的header參數(shù)都寫一個token，但是這樣的話十分不利于后期維護、修改。

打開全局參數(shù)管理器，在全局header填上token參數(shù)：

那么我們每次發(fā)送接口，都會在請求header中自動帶上該參數(shù)：

全局query和全局body的使用方法跟全局header類似，不再贅述。

5.2、目錄參數(shù)

目錄參數(shù)的作用和全局參數(shù)雷同，只是作用域不一樣，B目錄下的接口不會使用同級的A目錄的目錄參數(shù)作為發(fā)送參數(shù)。

我們可以通過編輯目錄進行目錄參數(shù)的填寫：

那么我們每次發(fā)送該目錄下的接口，都會在請求header中自動帶上該參數(shù)：

5.3、參數(shù)的優(yōu)先級

當全局參數(shù)、目錄參數(shù)、接口中都使用了同一個參數(shù)時，最終會按照以下優(yōu)先級讀取參數(shù)值：

單個接口 > 目錄參數(shù) > 全局參數(shù)

如上面的示例，如果全局參數(shù)、目錄參數(shù)、接口中都定義了header參數(shù)token：

全局參數(shù)：token值為：698d51a19d8a121ce581499d7b701668 // 最低優(yōu)先級
目錄參數(shù)：token值為：b50e345cc9febd86dedecc551ebcc505 // 其次優(yōu)先級
單接口參數(shù)：token值為：a1a9db893bb8a28ccb665d2af54d9417 // 最高優(yōu)先級

那么最終發(fā)送的token值為：a1a9db893bb8a28ccb665d2af54d9417

6、流程測試

流程測試是針對一個接口集合的測試，選擇相應(yīng)的環(huán)境，可以作為一系列請求一起運行。點擊開始，接口集合會并發(fā)的像服務(wù)器發(fā)出請求，最后會按照定義好的測試校驗?zāi)K給出測試結(jié)果。

6.1、流程測試過程

創(chuàng)建一個流程測試需要如下步驟：

1、新建接口，并添加斷言
2、打開流程測試，新建一個流程
3、向流程添加測試接口
4、選擇環(huán)境，點擊開始測試
5、查看返回的測試接口

流程測試界面如下圖：

6.2、查看流程測試中單個接口的信息

通過點擊接口名稱查看請求的請求和響應(yīng)參數(shù)信息。

總結(jié)

除了上面總結(jié)的一些常用功能，ApiPost還支持其他一些功能，比如：

• 接口回收站
• 自動生成代碼
• 多人協(xié)作管理
• 項目管理
• Cookie管理器
• 預執(zhí)行腳本和后執(zhí)行腳本
• …

整體上來看 ApiPost 無論是功能種類方面還是用戶體驗方面都比之前用的其他軟件更具優(yōu)勢，相當于同時把 Postman、Mock、Swagger 的功能壓縮為一個開發(fā)輔助軟件，真的非常 Nice，關(guān)鍵是完全免費提供給用戶使用，白嫖黨福音！

總結(jié)

以上是生活随笔為你收集整理的ApiPost的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

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