接口規(guī)范細(xì)節(jié)問題【JSON格式】

1、軟件開發(fā)接口文檔問題軟件開發(fā)過程中，后臺(tái)接口不規(guī)范導(dǎo)致的問題總結(jié)，現(xiàn)在后臺(tái)接口規(guī)范應(yīng)該學(xué)習(xí)restful風(fēng)格，具體參考網(wǎng)上資料1 .文檔存放問題目前存放是這種狀態(tài)：1.1 文檔雜亂分不清哪些是不用的接口，哪些是正在用的接口，哪些是更新后的接口1.2 接口查詢效率慢word格式管理，不方面查詢1.3 多個(gè)word文件，下載操作麻煩每次查看接口，需要下載word,不能避免下載操作查看，效率不高tj返回全部文件>接口>接口方文件名修也時(shí)間一晝近修改人大小Q原存單據(jù)r我改口公共接口02016-00-0213:51目全明340BQ索取打卡班次S匚片雙廚.杳1102016-09-0215:21

2、呂全明12a8KB考無設(shè)萱里新接口作波測(cè)試用例一2016-0-1415:31戶浩光1202KBD宮戶資料原有接口另口。2016-09-191:38昌全明11J1KBD五取商司編號(hào)接口.doc2016-09-1918:38呂全明11.99KBD莪取商機(jī)編號(hào)捷口添加商ff庠葩S試用201609-2011:34目全明1238KB耳囪空第UT同?？谡谕懼苌皇狡吆Ｃ? .文檔分工問題2.1 接口文檔的編寫后臺(tái)統(tǒng)一提供接口，沒有考慮到數(shù)據(jù)解析的便利性，客戶端解析帶來一定的不可避免的性能，邏輯方面的費(fèi)時(shí)【例如排序問題耗費(fèi)性能】，不利于最終客戶的體驗(yàn)；2.2 接口返回格式定義的問題需要解決后臺(tái)接口開發(fā)人員負(fù)

3、責(zé)編寫3 .文檔格式問題3.1 接口返回體問題3.1.1 json字符串未轉(zhuǎn)義問題無特殊需求盡量不要返回如此需要轉(zhuǎn)義的接口格式氣直七后”：(h皿八J;丫睿生輸人超過最大限制學(xué)S£5八WtcJcenA":己工afNfa業(yè)工admf心思'"*I"日痛ire"114234324534324"七叫L"寄主輸入超過最大限制字符士站，"tcke"1"dzalaifadJialszdJa",expire':1423432456J4324字符轉(zhuǎn)義問題3.1.2 沒有特殊需求，json格

4、式必須有key沒有key的返回體，客戶端需要做大量判斷處理，而且易讀性非常差,解析數(shù)據(jù)，容易產(chǎn)生錯(cuò)誤，不符合規(guī)范_QZi"i”對(duì)象里面有最一，但是比%塌空值”，口：日1、,匕亞”,生字，'n1.,“這是一個(gè)沒有支毛值得Zim巳逢例，數(shù)組里面設(shè)有上巳一I3.1.3 json格式的對(duì)象，數(shù)組不能輕易變更列表有數(shù)據(jù)的時(shí)候:S日'fLFs外.：丁備注輸入超過最大限制空付£50"01£：£":"dfa-adfd3fai3前3認(rèn)"expire"1142J43245£34321",i

5、目C0S"msg七崎在輸入超過最加艮制享符2骷*,"tcken!,r2adai3ad3±13£","expire11:U234324S63432i列表沒有數(shù)據(jù)的時(shí)候:SQ"data":E'F5：”TF且TS”二叮LID./l(!"備:主輸入能過最大限制字付Z55wjAtokeuX;Vdfafadtafala"rwexpire"：142343245S34324-,Fray“：(3'L“口m”皆主輸入超過最大限制第y,explrf：1423432456343243.1.4

6、json格式之?dāng)?shù)組最好不要寫成如下格式1,2,3,43.1.5 json數(shù)組分組排序問題按照組名字段排序，分組問題，客戶端需要做額外的處理【涉及到額外的循環(huán)耗時(shí)】WUhMJ.匚工;1LU:1XI：.WUWb,"data":Q''dat*-f-nndeaiL"!Q旺(Fd_jairticm)單據(jù)出號(hào)-jeld":d><2_code;"fdJTCUF"：,"fd-detncsS,*"rreadDLy："T"k"ind_iadefault":CtfFdi

7、d"H57540XQ、ion""所屬公司",fd_field*1;"wc?_ccp-Troup":1,fd_ietnc,':3r"fd_iypc*："SF"f"Oscnly"T"(adEauLc-":l,"句idrt:1614?9,Q(*Ffd_c.dption.,r:“人員類ar.;"wo-_jn4nkLi"r,Ffd_7iouF'r:,“fd_4已tnc"：4,"±dtype"

8、:P'1.1.6 json格式返回移動(dòng)端不需要的格式，字段以及無用數(shù)據(jù)1.1.7 json對(duì)象具體字段數(shù)據(jù)類型不要變動(dòng)I-“匕占工艮1"dsiaiL"data"!ndMwIX"孰"："瞽莊輸入®3最大限制享符及5丁/*token1,;"dfafBd£ad3fsda£dsa*P-eMpirEtl;142343245m324flfJr上船蓄莊輸入起遢最大限制室其工lp:PmL父：("demol":"-dita":"demlk*:JL八,%/七

9、借注輸入超過最大隔制宇0255","tcken"；：KdfafadfadsfadafdsaX",fleap£re":142343245(143241r*army*;F；十音主輸入超過最大限制字符£53)匕芥”：1,F二依父：3.2 接口統(tǒng)一異常提示問題客戶端開發(fā)人員的“尷尬”：面對(duì)如下的異常問題，客戶端不知道該返回給客戶看什么？直接提示“程序錯(cuò)誤”不好，客戶端開發(fā)人員直接固定返回錯(cuò)誤提示“系統(tǒng)錯(cuò)誤”也不好，相當(dāng)于接口返回體沒有起到應(yīng)有的作用；例如輸入表單的時(shí)候，輸入格式不對(duì)，后臺(tái)無法保存的時(shí)候，不能一概提示程序錯(cuò)誤！建議而是根據(jù)客戶端傳遞給服務(wù)端的指定參數(shù)，通過判斷參數(shù)的方式，來檢查是哪一個(gè)環(huán)節(jié)產(chǎn)生了問題，然后具體通過接口返回體的方式，返回給客戶端【核心原則，接口提供方給接口使用方更人性化的提示信息】,最終面對(duì)的都是客戶，不能讓客戶知道不友好的提示。a：不友好的提示：b:友好的提示:0("lata":1|JfH33二葉普生輸入超過最大E艮制室若2居I“tck=三三Km”"«xp