# Niushop開源商城api接口命名規范
---
### **命名規范:**
接口類要簡潔:article,help,goods,member,login,pintuan,bargin
接口方法按照主題加操作類型來命名:
統一命名規則:
動作相關放在主題前面,查詢相關放在主題后面
分類:類名主題+class helpClass
列表:類名主題+List\(分頁為主\) articleList,goodsList
列表:類名主題+Query\(不分頁\) goodsQuery
基礎信息:類名主題+Info memberInfo
詳細信息:類名主題+Detail memberDetail
添加: Add+類名主題 addAddress
編輯:update+類名主題 updateMember
刪除:delete+類名主題 deleteAddress
修改字段:modify+類名主題 modifyMemberPass
通過某種途徑或者方法:類名主題+操作類型+By+主題 memberRegisterByTel
特殊命名特殊含義比如:wechatLogin memberRegister
接口參數:統一小寫加下劃線 page\_index
返回值類型必須一致,尤其是對象類型,如果沒有值則返回null,方便Android和IOS轉換實體類。
在整理接口的同時,要把個人署名刪除掉。
對應的功能要放到對應接口里。
所有接口繼承BaseApi(原名BaseController)