2020至今，由于各種原因，越來越多企業選擇遠程辦公，Eolinker 結合自身長期的遠程研發協作經驗，為企業推出 API 管理遠程協作指南，以下方案不僅在 Eolinker 內部，也在眾多客戶中得到驗證，希望能夠幫助您快速了解如何將 API 管理與自動化測驗運用在實際的遠程辦公中，
API 管理的發展程序、痛點及解決方案
在過去，許多研發團隊并不注重研發程序中的 API 管理，認為API管理無非是管理一下API檔案，只需要用word檔案或者wiki把API描述寫一下，等到需要進行團隊協作的時候再把API檔案通過檔案或者wiki的方式發給前端和測驗人員即可，這時候的API管理方式粗放，我們把它稱之為1.0時代，
但隨著敏捷觀念的不斷普及，大家開始發現傳統的API管理只側重管理API檔案是不行的，存在以下明顯的問題：
- 1、API檔案撰寫不規范：缺乏統一檔案格式，簡寫、漏寫或不寫詳細說明（開發人員總覺得自己看得懂即可），
- 2、儲存平臺不統一：公司內部每個專案團隊都有自己的使用習慣，甚至一個專案內部可以同時存在多個API管理工具，平臺不統一導致無法高效維護和協作，
- 3、檔案更新不及時：開發團隊習慣于先開發后補檔案，認為檔案對于開發作業而已是一個附加的內容，導致更新不及時，
- 4、變更歷史不記錄：由于沒有及時維護檔案，當需要回頭檢查專案或進行作業交接時就會發現看檔案不如看代碼，反而拖慢作業進度，
- 5、測驗人員無法快速撰寫測驗用例：由于傳統API檔案僅僅是個檔案，測驗人員還需要使用其他工具撰寫測驗用例，
- 6、并沒有降低溝通成本：由于上述原因，前端、后端、測驗、運維等成員經常由于不清晰的檔案而引發爭論，有時候反而增加了溝通成本，
為了解決上述問題而出現2.0時代的工具，開始思考如何將開發與測驗結合，比如通過代碼注解生成API檔案來減少后端開發撰寫檔案的負擔、可以基于API檔案直接進行測驗等，這個時代最突出的產品是Swagger、Postman、Jmeter、SoupUI等產品，隨著研發測驗一體化的觀念推廣，這些產品逐漸成為目前主流API管理與測驗工具，有著龐大的用戶群體，
但是上述產品出現時并未流行遠程協作，因此其產品設計基本是基于本地開發和個人使用，因此當遇到越來越高的迭代速度和質量要求時便顯得力不從心，從而出現以下問題：
- 1、前端開發進度受制于后端：單純API檔案缺乏Mock API，前端需要等待后端開發完成才能拿到測驗資料，自己構造測驗資料費時費力，
- 2、檔案變更不通知：后端開發改了代碼和介面習慣于口頭溝通，而不是通過檔案明確地指出修改的內容，導致后期溝通成本高昂，
- 3、介面測驗不方便：需要看著介面檔案再另外使用工具進行測驗，如果介面發生了變化，寫好的測驗也作廢了，增加了重復作業量，
- 4、測驗作業重復：需要看著介面檔案再另外使用工具進行測驗，如果介面發生了變化，寫好的測驗也作廢了，增加了重復作業，
- 5、作業成果無法分享：每個測驗人員都用單機測驗工具撰寫測驗腳本，但卻沒法共享和協作，
- 6、測驗作業不自動化：一直希望促進自動化測驗，但是沒有真正運作起來，每天“點點點”依然消耗大量測驗團隊的精力，
- 7、測驗效果無法量化：無法準確了解測驗效果，沒人可以說清今天、昨天、上周、這個月的測驗情況如何，和之前比有何改進，
- 8、測驗作業被動：測驗總是排在最后進行，無法參與專案討論，無法進行快速大范圍回歸測驗，甚至無法按時完成測驗任務，導致專案延期或帶著忐忑上線，
并且這些產品并未解決 API 研發協作程序中的核心問題：如何將開發、測驗、運維、團隊協作四者結合，成為一個適用于團隊的、靈活的、統一的API管理平臺，并且能夠為后續API監控、運維提供直接的支持，
我們將實作了開發、測驗、運維、協作等四大要素的成為3.0時代的產品，而 Eolinker 自2017年成立以來，一直致力于構建 API 全生命周期管理解決方案，目前是國內最大的在線 API 研發管理平臺，旗下的線上SaaS產品以及離線私有化產品包括：
API 生成平臺（API Factory）
API 研發管理與自動化測驗平臺（API Studio）
API 監控平臺（API Monitoring）
API 微服務網關平臺（API Gateway）
API 開放平臺（API Open Platform），即將發布
Eolinker API Studio 的理論基礎：檔案與測驗驅動開發（DTDD）
相信大家早已聽說過以下開發模式：檔案驅動開發（DDD）以及測驗驅動開發（TDD），
檔案驅動開發指的是在開發之前先把檔案寫好，明確功能需求、入參出參定義、例外情況處理等之后再進行開發，這就好比我們在做題之前需要先了解清楚題目要求，否則不審題就下筆很容易導致最后返工，
而測驗驅動開發指的是在開發之前先把測驗方案/用例寫好，只開發能夠順利通過測驗的功能，如果測驗不通過則持續進行改進，這就好比我們考試前會先了解考試通過的標準，沒有標準亂答一通肯定沒有好結果，
以上兩種開發方式進行結合后就是 Eolinker API Studio 的設計理念：檔案與測驗驅動開發（DTDD），簡單地說就是：
用標準檔案代替口頭約定和筆記檔案，讓開發、測驗、運維、協作有跡可循；
快速用測驗結果推動開發進度，讓團隊溝通更充分、管理有事實依據，實作敏捷開發，
因此，在 Eolinker API Studio 中，幾乎所有的協作作業都是圍繞著 API 檔案進行的，當你創建了 API 檔案之后，你可以隨時查看 API 的改動情況、根據 API 檔案發起 API 測驗、撰寫 API 測驗用例、創建 Mock API、進行 API 自動化測驗等，
我們在接觸了大量的客戶后發現，采用 “DTDD” 模式比單純用TDD或DDD方式的效果更好，相比之前提到2.0時代的研發效率提升以及專案質量提升更是要提高數倍，
因此我們非常建議您嘗試這種方式進行作業，
初識 API Studio
創建第一個 API 管理專案
在 Eolinker API Studio 中，所有的 API 都是以專案的方式進行妥善管理，因此我們首先需要創建一個 API 管理專案，同時我們也提供了一鍵匯入功能，可以快速將Swagger、Postman、RAP、YAPI等產品內的資料快速遷移到 Eolinker 中，
創建 API 檔案
在 API Studio 中，您可以通過三種方式來創建API檔案：
1、手動創建API檔案，API Studio提供了非常全面的API檔案格式，能夠詳細記錄您的API資訊，這種方式適合所有用戶，并且也是我們推薦的方式，
2、關聯專案與Swagger URL，API Studio自動從該地址獲取最新API檔案，這種方式適合之前已經在使用Swagger，并且傾向于將檔案寫在代碼注解中的用戶，但這種方式會帶來代碼入侵的問題，讓代碼中加入了許多無關的資訊從而增加維護成本，
3、關聯專案與代碼倉庫，API Studio自動從代碼倉庫中掃描代碼注解生成API檔案，目前這種方式支持Java以及PHP兩種語言，這種方式也會帶來代碼入侵的問題，
當我們創建好 API 檔案之后，可以在 API Studio 中看到清晰的 API 檔案資訊，并且可以在此基礎上進行測驗API、撰寫API測驗用例、撰寫Mock API、管理API版本等等的操作，
一鍵發起 API 測驗
當我們創建好 API 檔案之后，可以立刻對該 API 進行測驗，API Studio 提供了以下主要特性來幫助測驗人員快速發起 API 測驗：
- 支持本地測驗、局域網測驗、在線測驗等；
- 支持一鍵切換測驗環境，使用全域變數、增加額外請求引數、改變請求地址等；
- 支持直接在界面編輯JSON、XML請求資料，不再需要手寫JSON、XML等資料結構；
- 支持將測驗資料保存為測驗用例，以后可以直接使用測驗用例進行測驗；
- 支持批量測驗 API，比如測驗登錄介面的多種情況并且回傳實時測驗資料；
- 支持在測驗程序中撰寫代碼進行簽名、加解密、生成隨機資料等操作；
- …
下圖：在測驗界面可以直接撰寫JSON資料，
下圖：一秒切換測驗環境并且發起測驗，
批量測驗多個 API 用例，解放測驗勞動力
在以往的協作方式中，測驗人員作業總是排在最后進行，無法參與專案討論，無法進行快速大范圍回歸測驗，甚至無法按時完成測驗任務，導致專案延期或帶著忐忑上線，
在 API Studio 中，由于協作是基于 API 檔案進行的，當后端開發人員將 API 檔案寫好之后，測驗人員就可以馬上介入，在 API 檔案的基礎上撰寫測驗用例，讓測驗作業前移，
當 API 開發完成之后，測驗人員可以一鍵將 API 的測驗用例全部測完，并且得到詳細的測驗報告，后端開發只需要看到測驗結果就能夠知道自己的 API 是否滿足測驗需求，如果有例外則可針對性改進，
當 API 發生改變后，測驗人員只需要一鍵即可進行 API 回歸測驗，真正解放勞動力，
通過上述方式，后端和測驗人員可以進行更緊密地溝通，讓測驗驅動開發完成，
下圖：批量測驗 API 的多種資料情況，并且獲得詳細測驗報告，可以在報告中查看API例外原因，
構建 Mock API，讓前端擺脫后端束縛
在瀑布流開發模式中，如果前端開發人員需要進行頁面對接，需要后端先完成 API 的開發作業，因此前后端開發的進度會互相影響，
通過 Mock API，您可以事先撰寫好 API 的資料生成規則，由 API Studio 動態生成 API 的回傳資料，開發人員通過訪問 Mock API 來獲得頁面所需要的資料，完成對接作業，
Mock API 支持根據不同的請求引數回傳不同的 HTTP Status Code、Header、Body等資料，你可以在一個 API 檔案里創建多個Mock API ，模擬前端發起的各種請求，方便對前端邏輯進行校驗，
當專案正式發布時，只需將 Mock API 的地址前綴替換為實際的訪問地址即可，
比如：同一個專案中的Mock API的地址前綴是相同的（如mock.eolinker.com/uasyd1/…），因此可以在代碼中將Mock API的地址前綴作為全域變數，專案上線時僅需替換變數的值即可改變整個專案的 API 請求地址前綴，
下圖：該API創建了多個Mock API，前端可以傳遞不同的請求引數獲取相應的回傳結果，比如用戶名為 jack liu時回傳登錄成功，用戶名為 percy時回傳登錄失敗或隨機字串，
當 API 檔案發生變更時自動通知相關成員
許多用戶在維護 API 時，經常遇到 API 檔案變更了，但是前端和測驗人員卻不知道的問題，為了解決這個痛點，API Studio 提供了變更通知功能，當 API 發生變化時通過郵件和站內信自動通知相關成員，并且顯示變更的內容，
并且在 API Studio 中，我們將 API 的狀態劃分為以下階段，方便成員在查看 API 檔案時了解 API 當前所處的狀態，
結合 API 變更通知的功能，我們就能夠實作：
1.當API狀態變為“開發”時，通知后端開發；
2.當API變為“對接”時，通知前端進行對接；
3.當API變為“測驗”時，通知測驗人員進行測驗；
4.等等…
下圖：設定當API洗掉或例外時，通知某位成員，
遠程協作時，直接對 API 檔案進行評論標注
當您進行遠程協作時，可以直接在 API 檔案上發布評論，所有的溝通內容都會跟隨 API 檔案保留下來并且按照版本分類好，而不是零散地存在各種聊天工具中，這樣避免后期溝通時找不到依據而浪費時間，
下圖：在 API 檔案中直接發表評論，并且@了專案中的另一位成員查看，
查看、回滾、對比API編輯歷史
API Studio中還提供了非常強大的 API 版本管理功能，您可以隨時回滾到任意一次 API 檔案版本，并且還可以對比兩個版本之間的差異，
當無法用語言溝通更新了什么時，不妨試試版本對比~
如下：當前版本相比歷史版本，刪減了某些引數，會在界面中以紅色標出，
除此之外，還有…
API Studio的功能還遠不止如此，您可以在專案中進行嚴格的人員權限管理、API狀態碼管理、專案檔案管理、測驗環境管理等等，一切都是為了讓團隊協作能夠更加輕松高效，
進階！通過 API Studio 打造 API 自動化測驗平臺！
快速了解市面上領先的 API 自動化測驗
在 API Studio 中還提供了目前市面上領先的 API 自動化測驗功能：
1.零代碼自動化測驗：不需要寫任何代碼即可進行 API 自動化測驗；
2.代碼模式自動化測驗：撰寫少量 Javascript 代碼即可進行復雜流程的自動化測驗；
3.支持操作資料庫：測驗程序中支持操作資料庫，執行資料插入、洗掉、編輯等操作；
4.資料驅動測驗：一個測驗用例支持測驗多組資料，分別生成測驗報告；
5.自動生成測驗報告：每次測驗都可以生成詳細測驗報告，支持在線查看和離線下載；
6.支持定時測驗任務：設定定時器自動執行測驗任務，將報告發送給指定人員郵箱；
7.支持 Open API 觸發測驗：可以通過 API 對接 Jenkins，隨時進行 API 自動化測驗；
8.極低學習門檻：15分鐘培訓即可快速上手進行 API 自動化測驗；
可以幫助您快速解決以下常見問題：
1.需求發布前需要對專案進行回歸測驗，傳統測驗方式的覆寫面窄、效率低下，可以用自動化測驗提高測驗范圍以及效率；
2.產品需求變動/代碼改動后，測驗人員無法確定測驗范圍，可以用自動化測驗進行大范圍回歸測驗保證基本業務正常；
3.傳統測驗方式的周期長，無法每天、每小時、24小時隨時執行測驗，并且依賴于人的專業性，測驗效果不可靠，可以用 API 自動化測驗的定時測驗任務或者將 API Studio 集成到 Jenkins 上，實作代碼提交即觸發測驗并實時得到測驗報告，
4.傳統測驗團隊成員之間缺乏協作，互相不清楚各自撰寫的測驗用例、測驗腳本、測驗結果等，導致重復勞動，可以用 API Studio 實作測驗團隊的在線協作，
5.測驗團隊使用 API Studio 日常維護 API 自動化測驗用例后，可有效解決上述問題，幫助測驗團隊提高測驗能力和效率，
在 API Studio 中，我們提供了 UI 和代碼模式兩種測驗用例撰寫模式：
1.UI模式：支持通過界面模式編輯 API 自動化測驗用例，無需撰寫代碼即可完成較復雜的API自動化測驗作業，
2.腳本模式：通過撰寫Javascript代碼，可以完成復雜的API自動化測驗作業，
由于篇幅原因，我們在此僅演示 API Studio 的自動化測驗效果，如需了解具體內容可以訪問 Eolinker 官方網站查看，
如下圖所示，您可通過界面方式編輯 API 測驗流程、API 之間的資料管理、回傳的校驗規則，甚至是插入資料庫操作等，然后一鍵即可獲得測驗報告，
腳本模式中，您只需要撰寫幾行代碼即可發起測驗，并且支持從 API 檔案自動生成測驗腳本！
我們可以選擇多個測驗用例，一鍵批量測驗并得到測驗報告，
通過更多方式觸發 API 自動化測驗
API Studio 中提供了多種自動化測驗的觸發方式：
手動觸發；
定時觸發；
Open API 觸發，可對接到 Jenkins 等持續開發平臺中，
靈活運用即可打造一個屬于您的測驗效率神器！
了解更多關于 Eolinker 的產品資訊
疫情的肆虐讓無數的企業經營受阻，以上是Eolinker 結合自身長期的遠程研發協作經驗，為企業推出 API 管理遠程協作指南，以下方案不僅在 Eolinker 內部，也在眾多客戶中得到驗證，希望能夠幫助您快速了解如何將 API 管理與自動化測驗運用在實際的遠程辦公中，我們希望能夠為此盡綿薄之力，幫助更多企業從傳統、低效的開發方式中解脫出來，
官方網站：https://www.eolinker.com/
轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/208616.html
標籤：其他