ApiPost
大家好，我是路飛！今天這篇文章，給大家介紹一款非常好用的國內軟件自研發的開發輔助軟件 ApiPost！
作為一個名服務端開發者，我們在日常工作中離不開接口測試、接口文檔編寫、Mock 數據測試、前后端接口聯調。為了完成這些任務，我們經常需要用到 Postman、Swagger、Mock Js等等，而今天這款軟件是恰好包含了這三者所有的功能，以及額外的擴展功能！
ApiPost = Postman + Swagger + Mock
一、什么是ApiPost？
1、介紹
- 官網地址：apipost.cn
ApiPost是一款將接口調試+接口文檔快速生成+接口文檔規范化管理+Mock API+接口流程測試集成一體的輔助開發軟件。
ApiPost產生的初衷是為了提高研發團隊各個角色的效率！產品的使用受眾為由前端開發、后端開發和測試人員以及技術經理組成的整個研發技術團隊。
2、面向的用戶群體
- 前端開發人員：支持接口文檔預覽、接口Mock數據、接口調試、前端代碼自動生成。
- 后端開發人員：支持接口文檔自動生成、支持接口文檔測試調用。
- 測試開發人員：支持接口調試、接口自動化測試。
- 研發經理：規范接口文檔管理、提升整體研發團隊效率。
二、ApiPost下載與安裝
1、下載
- 下載地址：https://www.apipost.cn/download.html
選擇合適自己電腦操作系統的安裝包下載即可，這里我簡單演示一下Mac和Windows電腦上的安裝流程。
2、安裝
2.1、Mac上安裝
我的辦公電腦是M1芯片的MacOS系統，所以這里選擇下載 Mac 客戶端（arm64，適配M1芯片） 。dmg結尾的安裝包下載完畢后，直接雙擊運行即可安裝：
2.2、Windows上安裝
Windows電腦上我選擇 Window 64位 客戶端 ，下載完畢后直接運行exe文件即可。
安裝完成后，我們來簡單實操一下ApiPost的一些常用功能！
三、ApiPosts實操
- 官方幫助文檔：APIPOST 使用文檔
1、HTTP請求接口（獲取天氣預報信息）
ApiPost在測試請求接口時，和Postman一樣，主要注意下面幾個部分的參數配置即可：
- Header 參數：可以設置或者導入 Header 參數，cookie也在Header進行設置。
- Query 參數：Query 支持構造URL參數，同時支持 RESTful 的 PATH 參數（如:id）。
- Body 參數：Body 提供三種類型 form-data / x-www-form-urlencoded / raw ，每種類型提供三種不同的UI界面。這三者分別對應提交表單參數、提交有文件的表單參數、發送JSON對象或者其他對象。
這里簡單測試一下查詢所在城市天氣信息的天氣預報接口調用：
http://apis.juhe.cn/simpleWeather/query?city=杭州&key=351e0xxxxxxxxxxxxxx8b266- 1
完整的請求結果如下：
操作步驟：
- 1、點贊請求URL：https://blog.csdn.net//phoenix/web/v1/article/like
- 2、請求類型：POST
- 3、設置Cookie：在文章列表頁F12打開控制臺，拷貝請求Cookie信息。
- 3、Body請求參數：articleId: 122262651
從上面兩個案例，可以看到，ApiPost在接口測試、接口調用方面相比于純英的Postman，對國內開發者友好很多，而且在一些使用細節上既保留了Postman原有開發者用戶的操作習慣，還在原來基礎上增加了很多新的功能。
那么，ApiPost就只是一個增強版的Postman嗎？
肯定不是呀，下面我們來康康使用ApiPost如何快速一鍵生成接口文檔！
3、一鍵生成接口文檔
我們知道，在前后端協作開發時，接口文檔是必須要的。而接口文檔的編寫任務往往交給后端同學去負責，需要給出接口的各種參數要求以及參考實例等等，非常繁瑣。
為了前后端協作便利，很多公司使用 Swagger 作為接口文檔生成工具，嵌套在后端服務中，當后端開發著完成后端接口編寫，就可以自動生成接口文檔。
但是 Swagger 需要在后端模塊添加額外的 Swagger 集成代碼。而 ApiPost 剛好可以把 Swagger 和 Postman 二者的功能合二為一，對開發者帶來極大的便利性！如下圖所示：
點擊分享文檔/分享項目查看自動生成的接口文檔：
文檔如下所示：
4、Mock
ApiPost 可以讓前端開發者在沒有后端程序的情況下能真實地返回接口數據，可以用 ApiPost 實現項目初期純前端的效果演示，也可以用 ApiPost 實現開發中的數據模擬從而實現前后端分離。
- 官方文檔：ApiPost中使用Mock
編寫mock規則：
Mock 規則模板支持類型豐富（5.4版本起）。
- 基本數據(固定json結構)
- 基本數據(Mock隨機json結構)
如圖所示：
將生成的mock URL地址發給前端：
這樣前端就可以使用您模擬的數據進行先一步的調試開發了。當您的接口完成后，再替換回來即可。
注：APIPOST的 mock 是基于mock.js 開發的。具體文檔可以 參見 mock.js 詳細文檔。
5、全局參數和目錄參數設置
5.1、全局參數
在實際項目中，對于一批接口，往往具有相同的請求參數。此時，我們可以利用全局參數或者目錄參數實現。
例如：常見的token令牌參數，假使我們請求項目下的任何接口都需要在header帶上token參數，那么我們當然可以每個接口的header參數都寫一個token，但是這樣的話十分不利于后期維護、修改。
打開全局參數管理器，在全局header填上token參數：
那么我們每次發送接口，都會在請求header中自動帶上該參數：
全局query和全局body的使用方法跟全局header類似，不再贅述。
5.2、目錄參數
目錄參數的作用和全局參數雷同，只是作用域不一樣，B目錄下的接口不會使用同級的A目錄的目錄參數作為發送參數。
我們可以通過編輯目錄進行目錄參數的填寫：
那么我們每次發送該目錄下的接口，都會在請求header中自動帶上該參數：
5.3、參數的優先級
當全局參數、目錄參數、接口中都使用了同一個參數時，最終會按照以下優先級讀取參數值：
單個接口 > 目錄參數 > 全局參數
如上面的示例，如果全局參數、目錄參數、接口中都定義了header參數token：
全局參數：token值為：698d51a19d8a121ce581499d7b701668 // 最低優先級
目錄參數：token值為：b50e345cc9febd86dedecc551ebcc505 // 其次優先級
單接口參數：token值為：a1a9db893bb8a28ccb665d2af54d9417 // 最高優先級
那么最終發送的token值為：a1a9db893bb8a28ccb665d2af54d9417
6、流程測試
流程測試是針對一個接口集合的測試，選擇相應的環境，可以作為一系列請求一起運行。點擊開始，接口集合會并發的像服務器發出請求，最后會按照定義好的測試校驗模塊給出測試結果。
6.1、流程測試過程
創建一個流程測試需要如下步驟：
1、新建接口，并添加斷言
2、打開流程測試，新建一個流程
3、向流程添加測試接口
4、選擇環境，點擊開始測試
5、查看返回的測試接口
流程測試界面如下圖：
6.2、查看流程測試中單個接口的信息
通過點擊接口名稱查看請求的請求和響應參數信息。
總結
除了上面總結的一些常用功能，ApiPost還支持其他一些功能，比如：
- 接口回收站
- 自動生成代碼
- 多人協作管理
- 項目管理
- Cookie管理器
- 預執行腳本和后執行腳本
- …
整體上來看 ApiPost 無論是功能種類方面還是用戶體驗方面都比之前用的其他軟件更具優勢，相當于同時把 Postman、Mock、Swagger 的功能壓縮為一個開發輔助軟件，真的非常 Nice，關鍵是完全免費提供給用戶使用，白嫖黨福音！
總結
- 上一篇： 电子音乐包括电声乐器和计算机音乐,电声乐
- 下一篇： 论文写作中的研究