一、API爆炸的時代隨著最近行業(yè)的移動化、物聯(lián)網(wǎng)化、數(shù)字化轉(zhuǎn)型、微服務(wù)等多種概念的提出,對應(yīng)的API數(shù)量已經(jīng)呈現(xiàn)出爆炸式增長,由此帶來的問題就是前后端的接口對接問題越來越來突出,我們能很難找到一個合適的技術(shù)工具提高我們的效率。由此帶來的問題就是接口對接的繁瑣,前端后端日常吵架。 1.背景介紹現(xiàn)在我們其實有很多的API工具,在API文檔設(shè)計有大名鼎鼎的 2.問題引出所以為了應(yīng)對上面的需求,我們需要的就是將這幾個常用軟件可以融合到一起,如果能夠做到數(shù)據(jù)完全互通,當我們修改一個地方的時候所有地方都進行修改那就太完美了。 3.解決方案今天在網(wǎng)上沖浪的時候發(fā)現(xiàn)了Apifox這款神器,官方宣傳就是將多種行業(yè)的巨頭軟件進行了整合為一個統(tǒng)一的程序,通過一套系統(tǒng)、一份數(shù)據(jù),解決多個系統(tǒng)之間的數(shù)據(jù)同步問題。只要定義好接口文檔,接口調(diào)試、數(shù)據(jù) Mock、接口測試就可以直接使用,無需再次定義;接口文檔和接口開發(fā)調(diào)試使用同一個工具,接口調(diào)試完成后即可保證和接口文檔定義完全一致。高效、及時、準確! 官網(wǎng)地址: https:///a1mnxxlm1 軟件現(xiàn)在已經(jīng)支持web版了,所以整體的體驗都是在web上進行的。 二、核心功能1.API文檔在API文檔部分,不在是往日冷冰冰的文檔,而是完全可視化、這無疑降低了我們的學(xué)習(xí)成本、并且文檔是遵循 OpenAPI 規(guī)范的,也能提高我們文檔的規(guī)范性。 2.API調(diào)試在接口調(diào)試部分,我們一個接口可以創(chuàng)建多個用力并且自動跟隨接口進行變更,并且Postman用的功能,Apifox都擁有,可以進行環(huán)境變量、全局變量、前后置腳本、全局共享等等功能,可謂是全面。并且支持運行任何語言代碼:js、java、py、php等。 3.Mock 數(shù)據(jù)Apifox完全支持 Mock.js 語法、并且擴展身份證、國內(nèi)手機號等常用規(guī)則,可以根據(jù)接口定義里的數(shù)據(jù)結(jié)構(gòu)、數(shù)據(jù)類型,自動生成 mock 規(guī)則。并且內(nèi)置智能 mock 規(guī)則庫,根據(jù)字段名、字段數(shù)據(jù)類型,智能優(yōu)化自動生成的 mock 規(guī)則。可自動識別出圖片、頭像、用戶名、手機號、網(wǎng)址、日期、時間、時間戳、郵箱、省份、城市、地址、IP 等字段,從而 Mock 出非常人性化的數(shù)據(jù)。支持自定義規(guī)則庫,滿足各種個性化需求。支持使用 正則表達式、通配符 來匹配字段名自定義 mock 規(guī)則。 4.自動化測試支持對相關(guān)的測試用例步驟和對應(yīng)的數(shù)據(jù)配置完成后進行自動化測試、我們可以很方便的對代碼進行自動化測試。 5. 在線調(diào)試這個文檔是用 Apifox 做的,我之前有試用過這個工具,沒想到最近又有這么多厲害的新功能出來了。點擊文檔右上角的運行按鈕,就會出現(xiàn)“在線運行”的模塊 這個界面上就能直接調(diào)試接口了!直接 1. 填參數(shù),2. 選環(huán)境,3. 點發(fā)送,接口請求就發(fā)出去了!下面就有返回結(jié)果!根本用不著 Postman!更不用把 API 照著抄一遍! 我心想,如果當時上線之前,用的是 Apifox 的話,那簡直是不會出現(xiàn)事故: 1、 參數(shù)不存在?我在線調(diào)試后獲得數(shù)據(jù)了,通過比對我知道哪個參數(shù)不存在; 三、其他功能1.代碼生成這個就很離譜,可以直接生成對應(yīng)的業(yè)務(wù)代碼,解放雙手從此成為ctrl + cctrl + v程序員,可以根據(jù)接口/模型定義,自動生成各種語言/框架的業(yè)務(wù)、模型代碼。并且支持 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等 130 種語言及框架。有點科幻。 2.數(shù)據(jù)導(dǎo)入/導(dǎo)出支持導(dǎo)出 OpenAPI (Swagger)、Markdown、Html 等數(shù)據(jù)格式。 支持導(dǎo)入 OpenAPI (Swagger)、Postman、HAR、RAP2、JMeter、YApi、Eolinker、RAML、DOClever 、Apizza 、DOCWAY、ShowDoc、I/O Docs、WADL、Google Discovery 等數(shù)據(jù)格式。 這樣就可以方便我們進行數(shù)據(jù)的遷移。而且我們也可以即時備份存檔,從此不為寫文檔而頭禿。 四、驚喜功能作為一個coder,最終的就是進行分享,Apifox官網(wǎng)的API Hub可以讓我們方便的查看別人的項目進行學(xué)習(xí),同時如果我們做了一份自認為完美的文檔也可以進行分享,分享才能使我們更加的強大??梢栽鰪娢覀兊妮敵瞿芰?。 五、總結(jié)整體體驗下來,只能說Apifox想的非常全面,可以讓我們從文檔書寫和接口對接工作中解脫出來,更加專注于代碼的書寫和業(yè)務(wù)邏輯的梳理,被接口對接煩透了的你不妨嘗試一下,你會發(fā)現(xiàn)它像一個保姆一樣為你做了所有該做的事情。 官網(wǎng)地址: https:///a1mnxxlm1 要是使用過程中有問題的話,還可以加入 Apifox 用戶群提問和學(xué)習(xí)。 |
|
來自: awoziji > 《設(shè)計來源》