# 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）