JAVA接口開發(fā)規(guī)范
1、 實現(xiàn)規(guī)范
a) 接口應(yīng)功能單一，并能正確相應(yīng)
b) 建議使用restful方式來實現(xiàn)
c) 不要返回null值
d) 服務(wù)已https對外提供，符合安全規(guī)范
e) 接口編碼盡量統(tǒng)一使用UTF-8
f) 接口參數(shù)的校驗
2、 代碼規(guī)范
a) 規(guī)范的類名、方法名、變量名等
i. 類名使用 UpperCamelCase 風(fēng)格，遵從駝峰形式
ii. 方法名、參數(shù)名带到、成員變量、局部變量都統(tǒng)一使用 lowerCamelCase 風(fēng)格英染，遵從駝峰形式,首字母小寫
iii. 常量命名全部大寫揽惹，單詞間用下劃線隔開
b) 有效完整的代碼注釋
c) 盡量使用post形式接受參數(shù)
d) 統(tǒng)一使用json格式返回響應(yīng)數(shù)據(jù)
e) 使用統(tǒng)一的接口相應(yīng)數(shù)據(jù)結(jié)構(gòu)：調(diào)用狀態(tài)碼status、狀態(tài)信息msg四康、自定義數(shù)據(jù)data
f) 有效的日志記錄
3搪搏、 文檔完善
a) 確保文檔的唯一性
b) 文檔內(nèi)容要豐富標(biāo)準(zhǔn)
i. 接口名稱、版本
ii. 用途箭养、調(diào)用場景慕嚷、授權(quán)
iii. 開發(fā)語言、編碼、協(xié)議喝检、簽名等
iv. 接口示例嗅辣、參數(shù)說明、返回值說明
JAVA接口開發(fā)規(guī)范
最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
- 文/潘曉璐 我一進(jìn)店門琐脏，熙熙樓的掌柜王于貴愁眉苦臉地迎上來攒砖，“玉大人，你說我怎么就攤上這事日裙〈低В” “怎么了？”我有些...
- 文/不壞的土叔 我叫張陵昂拂，是天一觀的道長受神。 經(jīng)常有香客問我，道長格侯，這世上最難降的妖魔是什么鼻听？ 我笑而不...
- 正文 為了忘掉前任，我火速辦了婚禮联四，結(jié)果婚禮上精算，老公的妹妹穿的比我還像新娘。我一直安慰自己碎连，他們只是感情好，可當(dāng)我...
- 文/花漫 我一把揭開白布驮履。 她就那樣靜靜地躺著鱼辙，像睡著了一般。 火紅的嫁衣襯著肌膚如雪玫镐。 梳的紋絲不亂的頭發(fā)上倒戏，一...
- 文/蒼蘭香墨 我猛地睜開眼，長吁一口氣：“原來是場噩夢啊……” “哼淑趾！你這毒婦竟也來了阳仔？” 一聲冷哼從身側(cè)響起，我...
- 正文 年R本政府宣布弱恒，位于F島的核電站，受9級特大地震影響棋恼，放射性物質(zhì)發(fā)生泄漏返弹。R本人自食惡果不足惜，卻給世界環(huán)境...
- 文/蒙蒙 一爪飘、第九天 我趴在偏房一處隱蔽的房頂上張望义起。 院中可真熱鬧，春花似錦师崎、人聲如沸默终。這莊子的主人今日做“春日...
- 文/蒼蘭香墨 我抬頭看了看天上的太陽齐蔽。三九已至，卻和暖如春床估，著一層夾襖步出監(jiān)牢的瞬間含滴，已是汗流浹背。 一陣腳步聲響...
