罪狀一：沒有文檔
罪狀二：文檔不全
罪狀三：接口參數(shù)沒校驗(yàn)
罪狀四：沒保證接口原子性
罪狀五：接口問題不斷

今天一位前端開發(fā)人員扯起了后端接口的皮，那個兄弟對后端人員提供的接口很大的意見（我是司空見慣），不過他說的也確實(shí)有道理，所以結(jié)合我的見解，希望提供接口的人員能多加注意。

罪狀一：沒有文檔

例如新的前端人員到了一個新的公司，使用接口時，問這個這個不知道，問那個那個不知道，要文檔沒文檔，這絕對是前端人員最抓狂的事，心里肯定是一千只草泥馬奔騰而過。

1.為什么要文檔？

文檔是當(dāng)前開發(fā)者甚至后面的接盤俠（后面開發(fā)者）能夠清晰往下做的指引。
即便是簡單的東西，但如果不寫文檔，以后口口相傳消耗的工作量會比寫文檔更多。
好記性不如爛筆頭，一段時候后，可能連開發(fā)者都忘記接口的用途。

2.文檔怎么寫？

在線文檔。

在線文檔易于更新和他人查看，例如可以使用Swagger編寫接口文檔。

PS：Swagger是一個規(guī)范和完整的框架，用于生成、描述、調(diào)用和可視化RESTful風(fēng)格的Web服務(wù)。

本地文檔。

本地文檔一般用Word文檔，但是比較不易傳播，但能離線查看。

Final~

文檔是及其關(guān)鍵的，無論是在線文檔還是本地文檔，有是關(guān)鍵。雖然寫文檔是麻煩的事，但對后端人員來說，是利人利己。

罪狀二：文檔不全

額，就是有了文檔，文檔里面對接口的描述也可能不全，可能缺每個參數(shù)詳盡描述（取值范圍、類型）、請求方式（GET、POST、PUT、DELETE）、返回數(shù)據(jù)的所有狀態(tài)等等。這里面可能最缺就是返回數(shù)據(jù)的狀態(tài)！

一般的返回數(shù)據(jù)結(jié)構(gòu)~

公司的數(shù)據(jù)接口返回結(jié)構(gòu)是

{
s : 0/ 1, //表示此操作的處理狀態(tài)（ status ），一般簡單的成功 /不成功，使用 1/0 表示。
m : 'xxxx', //表示此操作的提示信息（ message ），一般只用來顯示操作失敗時提示信息。
r : [], //表示此操作的返回值（ result ）
count : x //返回的數(shù)據(jù)條數(shù)
}

這種數(shù)據(jù)結(jié)構(gòu)看起來沒問題，確實(shí)也沒大問題，問題就是出在s這個字段。有許多的接口不僅僅只有兩種狀態(tài)，成功狀態(tài)只有一種倒是沒問題，問題就出在失敗狀態(tài)，失敗可能有很多情況，一個簡單的s:0不能說明失敗的原因（即便是有m提示信息，但用這個來區(qū)分很不靠譜，因?yàn)樘崾究赡軙兓?，我們不總是僅拿m做顯示用。

升級返回數(shù)據(jù)結(jié)構(gòu)~

那位同事建議以下方式應(yīng)答

{
s : 0/ 1/ 2/ 3, // 0代表正常，1是參數(shù)有誤，2是用戶不存在，3是用戶沒權(quán)限等等
m : 'xxxx', //表示此操作的提示信息（ message ），一般只用來顯示操作失敗時提示信息。
r : [], //表示此操作的返回值（ result ）
count : x //返回的數(shù)據(jù)條數(shù)
}

m、r、count 可以保持不變，但是s里面必須包含所有返回狀態(tài)，代表這個接口所有業(yè)務(wù)的情況，前端開發(fā)人員也就能針對每種情況進(jìn)行處理。

Final~

文檔最重要的部分是返回值的狀態(tài)，我也建議上面的升級返回數(shù)據(jù)結(jié)構(gòu)，這樣就不存在任何不明朗情況。既然寫了文檔，就把文檔寫好，寫明朗，這也是利人利己地方。

罪狀三：接口參數(shù)沒校驗(yàn)

這個前端人員倒不是很關(guān)注，因?yàn)楸旧碚{(diào)接口之前都會先做校驗(yàn)，后端做參數(shù)校驗(yàn)只是雙重保證。我之前也做過一段時間后端，也犯過沒校驗(yàn)參數(shù)的錯，額，因?yàn)楹髞頉]有做后端，也就沒有去修正。不過還是提醒后端人員，做好參數(shù)校驗(yàn)是第一步，不要偷懶了。

Final~

統(tǒng)一處理好接口校驗(yàn)，后端好好考慮下。

罪狀四：沒保證接口原子性

接口的原子性很重要，有時一個接口可能會干幾件事，但不一定都能正常完成，這就導(dǎo)致可能存在原子性問題，接口不能準(zhǔn)確被調(diào)用。

PS：原子性。一個原子事務(wù)要么完整執(zhí)行，要么干脆不執(zhí)行。這意味著，工作單元中的每項(xiàng)任務(wù)都必須正確執(zhí)行。如果有任一任務(wù)執(zhí)行失敗，則整個工作單元或事務(wù)就會被終止。即此前對數(shù)據(jù)所作的任何修改都將被撤銷。如果所有任務(wù)都被成功執(zhí)行，事務(wù)就會被提交，即對數(shù)據(jù)所作的修改將會是永久性的。

Final~

原子性一定要保證，保證，保證！

罪狀五：接口問題不斷

前端開發(fā)人員調(diào)接口時候，可能會存在各自各樣的問題，有問題可以理解，程序哪會沒有bug，但不能太離譜啊，后端兄弟們。所以我覺得在給出接口之前自己明確幾件事：

是否校驗(yàn)參數(shù)。
是否所有的情況都測試過了，如果可以請寫單元測試。
是否返回數(shù)據(jù)準(zhǔn)確明朗，響應(yīng)狀態(tài)碼是否正常。
文檔是否已經(jīng)完備。

總結(jié)

后端人員多體諒前端人員，在出現(xiàn)問題時，先檢查自身，別一上來就跟前端干起來，要是自己的問題就尷尬了。

來源：suo.im/5n3Dz3

本站僅提供存儲服務(wù)，所有內(nèi)容均由用戶發(fā)布，如發(fā)現(xiàn)有害或侵權(quán)內(nèi)容，請點(diǎn)擊舉報。

免费视频淫片aa毛片_日韩高清在线亚洲专区vr_日韩大片免费观看视频播放_亚洲欧美国产精品完整版

罪狀一：沒有文檔

罪狀二：文檔不全

罪狀三：接口參數(shù)沒校驗(yàn)

罪狀四：沒保證接口原子性

罪狀五：接口問題不斷

總結(jié)