扔掉 Postman，一个工具全部搞定，真香！
今日推薦
論異步編程的正確姿勢：十個接口的活現在只需要一個接口就能搞定!讓SpringBoot不再需要Controller、Service、Mapper，這款開源工具絕了！「吐血」我把 10 年的全部學習資源都分享在這里了還在用Spring Security？推薦你一款使用簡單、功能強大的權限認證框架干掉 navicat：這款 DB 管理工具才是y(永)y(遠)d(的)s(神)作為軟件開發從業者，API 調試是必不可少的一項技能，在這方面 Postman 做的非常出色。但是在整個軟件開發過程中，API 調試只是其中的一部分，還有很多事情 Postman 無法完成，或者無法高效完成，比如：API 文檔定義、API Mock、API 自動化測試等等。Apifox 就是為了解決這個問題而生的。
官網：www.apifox.cn
1
接口管理現狀
常用解決方案
使用 Swagger 管理 API 文檔
使用 Postman 調試 API
使用 RAP 等工具 Mock API 數據
使用 JMeter 做 API 自動化測試
存在的問題
維護不同工具之間數據一致性非常困難、低效。并且這里不僅僅是工作量的問題，更大的問題是多個系統之間數據不一致，導致協作低效、頻繁出問題，開發測試人員痛苦不堪。
開發人員在 Swagger 定義好文檔后，接口調試的時候還需要去 Postman 再定義一遍。
前端開發 Mock 數據的時候又要去 RAP 定義一遍，還需要手動設置 Mock 規則。
測試人員需要去 JMeter 再定義一遍。
前端根據 RAP Mock 出來的數據開發完，后端根據 Swagger 定義的接口文檔開發完，各自都試測試通過了，本以為可以馬上上線，結果一對接發現各種問題：
開發過程中接口變更了，只修改了 Swagger，但是沒有及時同步修改 RAP。
后端開發的接口數據類型和文檔不一致，肉眼難以發現問題。
同樣，測試在 JMeter 寫好的測試用例，真正運行的時候也會發現各種不一致。
時間久了，各種不一致會越來越嚴重。
2
Apifox 解決方案
如何解決這些問題
1、Apifox 定位
Apifox = Postman + Swagger + Mock + JMeter
Apifox 是 API 文檔、API 調試、API Mock、API 自動化測試一體化協作平臺。
通過一套系統、一份數據，解決多個系統之間的數據同步問題。只要定義好接口文檔，接口調試、數據 Mock、接口測試就可以直接使用，無需再次定義；接口文檔和接口開發調試使用同一個工具，接口調試完成后即可保證和接口文檔定義完全一致。高效、及時、準確！
2、Apifox 功能
接口設計：Apifox 接口文檔遵循 OpenApi 3.0 (原 Swagger)、JSON Schema 規范的同時，提供了非常好用的可視化文檔管理功能，零學習成本，非常高效。并且支持在線分享接口文檔。
數據模型：可復用的數據結構，定義接口返回數據結構及請求參數數據結構（僅 JSON 和 XML 模式）時可直接引用。支持模型直接嵌套引用，直接 JSON/XML 智能導入，支持 oneOf、allOf 等高級組合模式。
接口調試：Postman 有的功能，比如環境變量、前置/后置腳本、Cookie/Session 全局共享 等功能，Apifox 都有，并且比 Postman 更高效好用。接口運行完之后點擊保存為用例按鈕，即可生成接口用例，后續可直接運行接口用例，無需再輸入參數，非常方便。自定義腳本 100% 兼容 Postman 語法，并且支持運行javascript、java、python、php、js、BeanShell、go、shell、ruby、lua等各種語言代碼。
接口用例：通常一個接口會有多種情況用例，比如參數正確用例、參數錯誤用例、數據為空用例、不同數據狀態用例等等。運行接口用例時會自動校驗數據正確性，用接口用例來調試接口非常高效。
接口數據 Mock：內置 Mock.js 規則引擎，非常方便 mock 出各種數據，并且可以在定義數據結構的同時寫好 mock 規則。支持添加“期望”，根據請求參數返回不同 mock 數據。最重要的是 Apifox 零配置 即可 Mock 出非常人性化的數據，具體在本文后面介紹。
數據庫操作：支持讀取數據庫數據，作為接口請求參數使用。支持讀取數據庫數據，用來校驗(斷言)接口請求是否成功。
接口自動化測試：提供接口集合測試，可以通過選擇接口（或接口用例）快速創建測試集。目前接口自動化測試更多功能還在開發中，敬請期待！目標是：JMeter 有的功能基本都會有，并且要更好用。
快捷調試：類似 Postman 的接口調試方式，主要用途為臨時調試一些無需文檔化的接口，無需提前定義接口即可快速調試。
代碼生成：根據接口及數據數據模型定義，系統自動生成接口請求代碼、前端業務代碼及后端業務代碼。
團隊協作：Apifox 天生就是為團隊協作而生的，接口云端實時同步更新，成熟的團隊/項目/成員權限管理，滿足各類企業的需求。
Apifox 做的不僅僅是數據打通
如果你認為 Apifox 只做了數據打通，來提升研發團隊的效率，那就錯了。Apifox 還做了非常多的創新，來提升開發人員的效率。另外，關注公號“終碼一生”，回復關鍵詞“資料”，獲取視頻教程和最新的面試資料！
1、接口支持“用例管理”
通常一個接口會有多種情況用例，比如 正確用例 參數錯誤用例 數據為空用例 不同數據狀態用例。定義接口的時候定義好這些不同狀態的用例，接口調試的時候直接運行，非常高效。
2、“數據模型”定義、引用
可以獨立定義數據模型，接口定義時可以直接引用數據模型，數據模型之間也可以相互引用。同樣的數據結構，只需要定義一次即可多處使用；修改的時候只需要修改一處，多處實時更新，避免不一致。
3、調試時“自動校驗”數據結構
使用 Apifox 調試接口的時候，系統會根據接口文檔里的定義，自動校驗返回的數據結構是否正確，無需通過肉眼識別，也無需手動寫斷言腳本檢測，非常高效！
4、“可視化”設置斷言
設置斷言：
運行后，查看斷言結果：
5、“可視化”設置提取變量
6、支持數據庫操作
7、“零配置”Mock 出非常人性化的數據
先放一張圖對比下 Apifox 和其他同類工具 零配置 mock 出來的數據效果：
可以看出 Apifox 零配置 Mock 出來的數據和真實情況是非常接近的，前端開發可以直接使用，而無需再手動寫 mock 規則。
Apifox 如何做到高效率、零配置生成非常人性化的 mock 數據
Apifox 根據接口定義里的數據結構、數據類型，自動生成 mock 規則。
Apifox 內置智能 mock 規則庫，根據字段名、字段數據類型，智能優化自動生成的 mock 規則。如：名稱包含字符串image的string類型字段，自動 mock 出一個圖片地址 URL；包含字符串time的string類型字段，自動 mock 出一個時間字符串；包含字符串city的string類型字段，自動 mock 出一個城市名。
Apifox 根據內置規則，可自動識別出圖片、頭像、用戶名、手機號、網址、日期、時間、時間戳、郵箱、省份、城市、地址、IP 等字段，從而 Mock 出非常人性化的數據。
除了內置 mock 規則，用戶還可以自定義規則庫，滿足各種個性化需求。支持使用 正則表達式、通配符 來匹配字段名自定義 mock 規則。
Postman介紹
Postman是google開發的一款功能強大的網頁調試與發送網頁HTTP請求，并能運行測試用例的的Chrome插件。其主要功能包括：
模擬各種HTTP requests
從常用的 GET、POST 到 RESTful 的 PUT 、 DELETE …等等。甚至還可以發送文件、送出額外的 header。
Collection 功能（測試集合）
Collection 是 requests的集合，在做完一個測試的時候， 你可以把這次的 request 存到特定的 Collection 里面，如此一來，下次要做同樣的測試時，就不需要重新輸入。而且一個collection可以包含多條request，如果我們把一個request當成一個test case，那collection就可以看成是一個test suite。通過collection的歸類，我們可以良好的分類測試軟件所提供的API.而且 Collection 還可以 Import 或是 Share 出來，讓團隊里面的所有人共享你建立起來的 Collection。
人性化的Response整理
一般在用其他工具來測試的時候，response的內容通常都是純文字的 raw， 但如果是 JSON ，就是塞成一整行的 JSON。這會造成閱讀的障礙 ，而 Postman 可以針對response內容的格式自動美化。JSON、 XML 或是 HTML 都會整理成我們可以閱讀的格式
內置測試腳本語言
Postman支持編寫測試腳本，可以快速的檢查request的結果，并返回測試結果
設定變量與環境
Postman 可以自由 設定變量與Environment，一般我們在編輯request，校驗response的時候，總會需要重復輸入某些字符，比如url，postman允許我們設定變量來保存這些值。并且把變量保存在不同的環境中。比如，我們可能會有多種環境， development 、 staging 或 local， 而這幾種環境中的 request URL 也各不相同，但我們可以在不同的環境中設定同樣的變量，只是變量的值不一樣，這樣我們就不用修改我們的測試腳本，而測試不同的環境。
安裝Postman
Postman作為一個chrome的插件，你可以打開chrome，在chrome webstore里面找到。當然，如果是在國內，你需要翻墻，否則的話，你只能百度一下，搜索postman的安裝包自己安裝到chrome上（這里就不贅述了，有很多類似的文章）。這里需要提一下的是，你可以不用打開chrome而直接使用Postman，具體的方法是：
選項->更多工具->擴展程序
詳細信息->創建快捷方式->‘全部勾上’
這樣你就可以在任何地方啟動你的Postman了
Postman sending requests
安裝好之后，我們先打開Postman，可以看到界面分成左右兩個部分，右邊是我們后頭要講的collection，左邊是現在要講的request builder。在request builder中，我們可以通過Postman快速的隨意組裝出我們希望的request。一般來說，所有的HTTP Request都分成4個部分，URL, method, headers和body。而Postman針對這幾部分都有針對性的工具。
URL
要組裝一條Request, URL永遠是你首先要填的內容，在Postman里面你曾輸入過的URL是可以通過下拉自動補全的哦。如果你點擊Params按鈕，Postman會彈出一個鍵值編輯器，你可以在哪里輸入URL的Parameter，Postman會幫你自動加入到URL當中，反之，如果你的URL當中已經有了參數，那Postman會在你打開鍵值編輯器的時候把參數自動載入
Headers
點擊’Headers’按鈕，Postman同樣會彈出一個鍵值編輯器。在這里，你可以隨意添加你想要的Header attribute，同樣Postman為我們通過了很貼心的auto-complete功能，敲入一個字母，你可以從下拉菜單里選擇你想要的標準atrribute
Method
要選擇Request的Method是很簡單的，Postman支持所有的Method，而一旦你選擇了Method，Postman的request body編輯器會根據的你選擇，自動的發生改變
Request Body
如果我們要創建的request是類似于POST，那我們就需要編輯Request Body，Postman根據body type的不同，提供了4中編輯方式：
form-data
x-www-form-urlencoded
raw
binary
（我們這里是可以傳文件的哦）
演示
我這里創建一條發送給google geocode的request，看看是啥結果：
注意，在URL里面我使用了變量googleMaps，并用{{}}調用它，這里是類似于AngulaJs的語法（果然是同一家人），其返回值是：http://maps.googleapis.com/maps/api/geocode/json。而這個變量我是定義在我的環境GoogleApiTest里面的。這部分的內容會在接下來的文章里面講到。
點擊了Send之后，可以在Postman上直接看到response的內容，內容很漂亮，Postman根據內容檢索自動按JSON的格式顯示出來，同時我們可以清楚的看到status code和花費的時間。
寫到這，我想大家已經能夠了解如何用Postman組裝Request并且查看Response的內容了，那我們怎么用Postman去做測試呢，且聽下回分解
發現了痛點就要去找解決方案。解決方案用的人多了，就成了標準的規范，這就是Swagger的由來。通過這套規范，你只需要按照它的規范去定義接口及接口相關的信息。再通過Swagger衍生出來的一系列項目和工具，就可以做到生成各種格式的接口文檔，生成多種語言的客戶端和服務端的代碼，以及在線接口調試頁面等等。這樣，如果按照新的開發模式，在開發新版本或者迭代版本的時候，只需要更新Swagger描述文件，就可以自動生成接口文檔和客戶端服務端代碼，做到調用端代碼、服務端代碼以及接口文檔的一致性。
但即便如此，對于許多開發來說，編寫這個yml或json格式的描述文件，本身也是有一定負擔的工作，特別是在后面持續迭代開發的時候，往往會忽略更新這個描述文件，直接更改代碼。久而久之，這個描述文件也和實際項目漸行漸遠，基于該描述文件生成的接口文檔也失去了參考意義。所以作為Java屆服務端的大一統框架Spring，迅速將Swagger規范納入自身的標準，建立了Spring-swagger項目，后面改成了現在的Springfox。通過在項目中引入Springfox，可以掃描相關的代碼，生成該描述文件，進而生成與代碼一致的接口文檔和客戶端代碼。這種通過代碼生成接口文檔的形式，在后面需求持續迭代的項目中，顯得尤為重要和高效。
框架說明及使用
1.說明
現在SWAGGER官網主要提供了幾種開源工具，提供相應的功能。可以通過配置甚至是修改源碼以達到你想要的效果。
image.png
Swagger Codegen: 通過Codegen 可以將描述文件生成html格式和cwiki形式的接口文檔，同時也能生成多鐘語言的服務端和客戶端的代碼。支持通過jar包，docker，node等方式在本地化執行生成。也可以在后面的Swagger Editor中在線生成。
Swagger UI:提供了一個可視化的UI頁面展示描述文件。接口的調用方、測試、項目經理等都可以在該頁面中對相關接口進行查閱和做一些簡單的接口請求。該項目支持在線導入描述文件和本地部署UI項目。
Swagger Editor: 類似于markendown編輯器的編輯Swagger描述文件的編輯器，該編輯支持實時預覽描述文件的更新效果。也提供了在線編輯器和本地部署編輯器兩種方式。
Swagger Inspector: 感覺和postman差不多，是一個可以對接口進行測試的在線版的postman。比在Swagger UI里面做接口請求，會返回更多的信息，也會保存你請求的實際請求參數等數據。
Swagger Hub：集成了上面所有項目的各個功能，你可以以項目和版本為單位，將你的描述文件上傳到Swagger Hub中。在Swagger Hub中可以完成上面項目的所有工作，需要注冊賬號，分免費版和收費版。
PS：
Springfox Swagger: Spring 基于swagger規范，可以將基于SpringMVC和Spring Boot項目的項目代碼，自動生成JSON格式的描述文件。本身不是屬于Swagger官網提供的，在這里列出來做個說明，方便后面作一個使用的展開。
2.基于Spring框架的Swagger流程應用
這里不會介紹Swagger的工具具體如何使用，不會講yml或者json格式描述文件的語法規范，也不會講如何在SpringMVC或者Spring Boot中配置Springfox－swagger。這些都能從網上找到，而且配置起來都非常的簡單。
這里想講的是如何結合現有的工具和功能，設計一個流程，去保證一個項目從開始開發到后面持續迭代的時候，以最小代價去維護代碼、接口文檔以及Swagger描述文件。
2.1 項目開始階段
一般來說，接口文檔都是由服務端來編寫的。在項目開發階段的時候，服務端開發可以視情況來決定是直接編寫服務端調用層代碼，還是寫Swagger描述文件。建議是如果項目啟動階段，就已經搭好了后臺框架，那可以直接編寫服務端被調用層的代碼（即controller及其入參出參對象），然后通過Springfox－swagger 生成swagger json描述文件。如果項目啟動階段并沒有相關后臺框架，而前端對接口文檔追得緊，那就建議先編寫swagger描述文件，通過該描述文件生成接口文檔。后續后臺框架搭好了，也可以生成相關的服務端代碼。
2.1 項目迭代階段
到這個階段，事情就簡單很多了。后續后臺人員，無需關注Swagger描述文件和接口文檔，有需求變更導致接口變化，直接寫代碼就好了。把調用層的代碼做個修改，然后生成新的描述文件和接口文檔后，給到前端即可。真正做到了一勞永逸。
2.3流程
總結一下就是通過下面這兩種流程中的一種，可以做到代碼和接口文檔的一致性，服務端開發再也不用花費精力去維護接口文檔。
流程一
image.png
流程二
image.png
給Mock系統的正常請求及響應全流程數據
很多時候，如果你能在提供接口文檔的同時，把所有接口的模擬請求響應數據也提供給前端。或者有Mock系統，直接將這些模擬數據錄入到Mock系統中，那將會提高前端的開發效率，減少許多發生在聯調時候才會發生的問題。
通過適當地在代碼中加入swagger的注解，可以讓你的接口文檔描述信息更加詳細，如果你把每個出入參數的示例值都配上，那前端就可以直接在接口文檔中拿到模擬數據。相關的注解類及參數配置可以參考文末他人寫的技術文章，這里也不作展開了。
另外，關注公號“終碼一生”，回復關鍵詞“資料”，獲取視頻教程和最新的面試資料！
8、生成在線接口文檔
Apifox 項目可“在線分享” API 文檔，分享出去的 API 文檔可設置為公開或需要密碼訪問，非常方便與外部團隊協作。
地址：https://www.apipark.cn/s/ce387612-cfdb-478a-b604-b96d1dbc511b/http/5041285
9、代碼自動生成
根據接口模型定義，自動生成各種語言/框架（如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等）的業務代碼（如 Model、Controller、單元測試代碼等）和接口請求代碼。目前 Apifox 支持 130 種語言及框架的代碼自動生成。
更重要的是：你可以通過自定義代碼模板來生成符合自己團隊的架構規范的代碼，滿足各種個性化的需求。
10、導入、導出
支持導出 OpenApi (Swagger)、Markdown、Html 等數據格式，因為可以導出OpenApi格式數據，所以你可以利用 OpenApi (Swagger) 豐富的生態工具完成各種接口相關的事情。
支持導入 OpenApi (Swagger)、Postman、HAR、RAML、RAP2、YApi、Eolinker、NEI、DOClever、ApiPost 、Apizza 、ShowDoc、API Blueprint、I/O Docs、WADL、Google Discovery等數據格式，方便舊項目遷移。
后續功能規劃
接口性能測試支持（類似 JMeter）。
支持插件市場，可以自己開發插件。
支持更多接口協議，如GraphQL、websocket等。
支持離線使用，項目可選擇在線同步（團隊協作）還是僅本地存儲（單機離線使用）。
更多 Apifox 功能截圖
（點擊圖片查看大圖）
總結
以上是生活随笔為你收集整理的扔掉 Postman，一个工具全部搞定，真香！的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 推荐 15 款常用开发工具
- 下一篇： 分享一套开源微信后台开发源码，简单配置就