厦门号 
emer API命名规范指南
一、基础原则
API命名需遵循以下核心规则：
- 一致性：模块、函数、参数命名均采用统一风格
- 可读性：使用驼峰命名法（如getUserName）
- 无歧义：避免缩写和模糊表述
二、命名场景示例
| 场景 | 规范命名 | 错误示例 |
|---|---|---|
| 用户登录接口 | api/v1/login | api/loginUser |
| 查询订单 | api/v2/orders/{id} | api/queryOrder |
三、特殊字符处理
需避免以下情况：
- 使用特殊符号（如$、#）
- 包含空格或中文
- 重复命名（如userCreate与userCreateAction）
四、版本控制规范
接口版本需按以下格式编写：
api/v{n}/[模块名]（n为版本号，如v1、v2）
示例：api/v3/products
转载请注明出处: 厦门号
本文的链接地址: http://m.beforetime.org/post-9720.html
闽ICP备18028472号-1
最新评论
暂无评论