一、前后端的愛(ài)恨情仇
最近公司的一個(gè)前端同事和一個(gè)后端同事吵了一架，事情大概是這樣的。后端說(shuō)要聯(lián)調(diào)接口，前端說(shuō)你的數(shù)據(jù)盡量按我的要求來(lái)，后端不干，說(shuō)你這個(gè)沒(méi)用。前端就講道理呀，傳統(tǒng)的前后端分離返回的格式要盡量規(guī)范，這樣才好處理……后端同意了。
?很快，啪的一下，前端這邊請(qǐng)求剛發(fā)出去，立馬就返回了。誰(shuí)知大意了沒(méi)有閃，一個(gè)Code碼，一個(gè)字符串，一個(gè)數(shù)組，全部接受轉(zhuǎn)換成了模型，再正常處理業(yè)務(wù)邏輯和頁(yè)面展示，前端笑了笑提交測(cè)試，很快，一上正式環(huán)境程序就崩潰了。原來(lái)是字符串沒(méi)有判空，前端說(shuō)后端你不講碼德，后端說(shuō)對(duì)不起，是我不懂規(guī)矩，我是亂打的代碼。好家伙，一個(gè)訓(xùn)練有素的練家子會(huì)亂打？這明明是來(lái)糊弄咱老前端，不講碼德！
朋友只能勸他耗子尾汁，好好反思，以后不要再耍這種小聰明，畢竟程序員要以和為貴，搞窩里斗是萬(wàn)萬(wàn)不可的，求求不要再把空值異常拋給前端了！
其實(shí)在開(kāi)發(fā)過(guò)程中，前后端還會(huì)存在其他分歧，比如前端希望根據(jù) UI 來(lái)劃分接口，這樣用戶(hù)體驗(yàn)好，前端實(shí)現(xiàn)也容易。后端則更希望根據(jù)業(yè)務(wù)模塊劃分接口，這樣有利于服務(wù)下沉和解耦。
于是前后端間可能會(huì)出現(xiàn)如下對(duì)話(huà):
-
后端：你多調(diào)幾個(gè)接口不就行了么~
-
前端：多好幾個(gè) HTTP 請(qǐng)求呢。包成一個(gè)接口有這么難么？
前端和后端各有各的道理，還都不肯退讓?zhuān)ハ喑镀?，互相看不順眼，所以今天?lái)分析分析后端開(kāi)發(fā)者的痛點(diǎn)。
二、后端開(kāi)發(fā)者之痛
1、不愿意編寫(xiě)文檔，但又不得不寫(xiě)
對(duì)于后端工程師來(lái)說(shuō)，寫(xiě)接口文檔是很枯燥乏味的工作。往往寫(xiě)好一個(gè)規(guī)范的接口文檔也不會(huì)讓后端工程師有特別的成就感，但寫(xiě)好一個(gè)接口文檔需要填寫(xiě)各個(gè)瑣碎的字段。所以大家都更加愿意把時(shí)間花在編碼上，僅草草的應(yīng)付接口文檔的編寫(xiě)工作。但在研發(fā)團(tuán)隊(duì)協(xié)作中接口文檔編寫(xiě)是否規(guī)范，將影響到其他調(diào)用方對(duì)該接口的理解，文檔是否詳實(shí)一定程度上決定了對(duì)接聯(lián)調(diào)的時(shí)間。
2、API測(cè)試麻煩
后端工程師在接口開(kāi)發(fā)過(guò)程中，需要頻繁的進(jìn)行接口文檔調(diào)整，自測(cè)接口是否能輸出想要的結(jié)果。這時(shí)候就會(huì)遇到一個(gè)問(wèn)題，傳統(tǒng)接口工具的測(cè)試比較單一，且測(cè)試數(shù)據(jù)編寫(xiě)麻煩，返回錯(cuò)誤不容易定位。接口開(kāi)發(fā)過(guò)程中，這樣的調(diào)試過(guò)程需要循環(huán)多次，極不方便。
3、無(wú)法局部分享接口
一般swagger文檔是以某個(gè)服務(wù)為整體管理該服務(wù)下的API接口文檔。在聯(lián)調(diào)過(guò)程中，后端工程師需要把新增的或需要聯(lián)調(diào)的多個(gè)接口分享給對(duì)接人時(shí)，只能把整個(gè)服務(wù)文檔地址分享出去。然后截圖告知是哪幾個(gè)接口是本次有變更的，或者本次需要對(duì)接的。對(duì)于對(duì)接聯(lián)調(diào)來(lái)說(shuō)，十分不便。
4、新接手項(xiàng)目沒(méi)有文檔
在日常的軟件團(tuán)隊(duì)中，經(jīng)常會(huì)遇到需要借調(diào)或接手一個(gè)新項(xiàng)目。但令前后端工程師抓狂的是，很多時(shí)候會(huì)遇到新接手的項(xiàng)目沒(méi)有任何接口文檔，或者文檔并不規(guī)范。而“前人”已無(wú)法聯(lián)系了，這座代碼*山變成了不可攀越的高峰。
針對(duì)上述痛點(diǎn)，今天給大家推薦一款專(zhuān)業(yè)級(jí)的一站式API協(xié)作平臺(tái)Eolink。下面帶大家看看Eolink是如何解決后端開(kāi)發(fā)者的痛點(diǎn)。
體驗(yàn)地址：https://www.eolink.com/?utm_source=w3806
三、Eolink 提供的解決方案
1、根據(jù)代碼生成文檔
Eolink提供IDEA插件，可以基于代碼一鍵生成API文檔并同步到Eolink對(duì)應(yīng)的項(xiàng)目中。接口文章除了提供展示標(biāo)準(zhǔn)的基礎(chǔ)信息、請(qǐng)求參數(shù)、響應(yīng)參數(shù)等字段后。還可以增加例如字段額外說(shuō)明，標(biāo)簽，接口狀態(tài)等信息。若需要更加規(guī)范的文檔內(nèi)容，那么Eolink提供API文檔模板和數(shù)據(jù)結(jié)構(gòu)的功能，可以按各公司的需要生成對(duì)應(yīng)的模板，開(kāi)發(fā)者直接復(fù)用減少重復(fù)工作的同時(shí)，使得文檔更加規(guī)范可讀。
2、便捷的調(diào)試體驗(yàn)和自動(dòng)生成測(cè)試數(shù)據(jù)
Eolink 的API文檔中文檔編輯和測(cè)試是兩個(gè)相鄰的功能按鈕，符合后端工程師日常的工作場(chǎng)景。編輯完文檔后，可快速切換到測(cè)試界面進(jìn)行調(diào)試。并且系統(tǒng)會(huì)自動(dòng)根據(jù)文檔參數(shù)類(lèi)型和約束條件，自動(dòng)填入測(cè)試數(shù)據(jù)，后端工程師僅需點(diǎn)擊測(cè)試按鈕即可完成接口調(diào)試，省時(shí)省心更省力。
3、支持多場(chǎng)景分享文檔
Eolink 支持多種場(chǎng)景的API文檔分享?？珊蛃wagger一樣把全項(xiàng)目接口文檔進(jìn)行快速分享，也可以設(shè)置分享文檔的可見(jiàn)范圍，僅分享本次對(duì)接相關(guān)的接口。也可以對(duì)文檔設(shè)置分享密碼，提高資產(chǎn)安全性。更可以把測(cè)試用例等信息同步分享，調(diào)用方可快速使用測(cè)試用例了解接口返回情況。
4、標(biāo)準(zhǔn)規(guī)范的API管理工具
Eolink是一個(gè)一站式智能協(xié)作的API管理平臺(tái)，能把企業(yè)內(nèi)所有的項(xiàng)目按自定義的標(biāo)準(zhǔn)規(guī)范模板，沉淀在統(tǒng)一的API接口倉(cāng)庫(kù)中。無(wú)論前后端工程師去到哪個(gè)項(xiàng)目，即可獲得一份熟悉又標(biāo)準(zhǔn)的接口文檔供你使用。
以上功能，給后端后端聯(lián)調(diào)提供了很好的幫助。后端再也不用為了寫(xiě)接口文檔而煩躁，更不用擔(dān)心接口文檔規(guī)范的問(wèn)題。前端也不用再擔(dān)心多接口時(shí)沒(méi)有分類(lèi)菜單、JSON 參數(shù)不能格式化、返回結(jié)果不能折疊、參數(shù)出錯(cuò)的時(shí)候查找麻煩等一系列的問(wèn)題。
體驗(yàn)地址：https://www.eolink.com/?utm_source=w3806文章來(lái)源地址http://www.zghlxwxcb.cn/news/detail-788037.html
四、Eolink迷人的亮點(diǎn)
除了上述特點(diǎn)以外我還發(fā)現(xiàn) Eolink 幾個(gè)隱藏的亮點(diǎn)功能，用起來(lái)特別香！
-
API變更智能通知
-
API文檔評(píng)論功能
-
API歷史版本比對(duì)
-
定時(shí)測(cè)試任務(wù)
-
支持?jǐn)?shù)據(jù)驅(qū)動(dòng)
-
項(xiàng)目分析報(bào)表
我直接上圖，大家一看就懂。
?當(dāng) API 發(fā)生變化時(shí)通過(guò)郵件和站內(nèi)信自動(dòng)通知相關(guān)成員，并且已與QQ和飛書(shū)打通
直接在 API 文檔上發(fā)布評(píng)論，溝通內(nèi)容會(huì)跟隨 API 文檔不同版本存檔
?回滾查看API文檔歷史版本，智能查找不同版本文檔差異
?Eolink支持定時(shí)測(cè)試任務(wù)，或者將 API 自動(dòng)化測(cè)試平臺(tái)集成到Jenkins上，實(shí)現(xiàn)代碼提交即觸發(fā)測(cè)試，實(shí)現(xiàn)項(xiàng)目在無(wú)人值守的情況下自動(dòng)測(cè)試，解放勞動(dòng)力
?通過(guò)數(shù)據(jù)驅(qū)動(dòng)模擬多種場(chǎng)景，以此來(lái)看場(chǎng)景用例執(zhí)行情況，避免測(cè)試流程空跑，使測(cè)試案例更接近真實(shí)
強(qiáng)大的項(xiàng)目數(shù)據(jù)統(tǒng)計(jì)分析功能和醒目的可視化呈現(xiàn)，團(tuán)隊(duì)開(kāi)發(fā)工作一目了然
運(yùn)用這些小亮點(diǎn)可以使團(tuán)隊(duì)合作更加融洽，項(xiàng)目管理更加方便。在測(cè)試方面實(shí)現(xiàn)了項(xiàng)目在無(wú)人值守的情況下自動(dòng)測(cè)試，解放勞動(dòng)力。在文檔方面實(shí)現(xiàn)當(dāng)API發(fā)生變化時(shí)可以立刻通知相關(guān)成員，并且API文檔下還可以評(píng)論，使溝通更加方便。如果文檔出現(xiàn)問(wèn)題也可以通過(guò)歷史版本回滾來(lái)比對(duì)找出問(wèn)題。
體驗(yàn)地址：https://www.eolink.com/?utm_source=w3806
五、寫(xiě)在最后
至此，Eolink 常用的核心功能已經(jīng)介紹完了，但Eolink 的強(qiáng)大并不限于此，在團(tuán)隊(duì)管理、協(xié)同管理、項(xiàng)目管理的多個(gè)方面都表現(xiàn)的很優(yōu)秀，目前 SaaS 產(chǎn)品完全免費(fèi)，你可使用 web 版，也可下載桌面端，Windows、Mac、Linux 平臺(tái)均支持！如果你還沒(méi)有用過(guò)，建議嘗試一下，相信用過(guò)之后，一定會(huì)愛(ài)上！文章來(lái)源：http://www.zghlxwxcb.cn/news/detail-788037.html
體驗(yàn)地址：https://www.eolink.com/?utm_source=w3806
到了這里，關(guān)于Eolink 治愈了后端開(kāi)發(fā)者的痛的文章就介紹完了。如果您還想了解更多內(nèi)容，請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
