项目中 axios 文件的命名
常用命名
| 名称 | 描述 |
|---|---|
| list | 列出某一实体的多条记录 |
| show | 列出某一实体的指定一条记录 |
| create | 新建某一实体的一条记录 |
| update | 更新某一实体的一条记录 |
| remove | 删除某一实体的一条记录 |
命名方法
动词 + 名次的命名方法，以动词开头，直接使用 list、show、cancel、return；不建议使用 get 这类的动词开头。
| 名称 | 描述 |
|---|---|
| listOrders | 列出一系列的订单 |
| showOrder | 展示某一条订单 |
| returnOrders | 退回一系列的订单 |
| cancelOrder | 取消某一条订单 |
常见场景
| 名称 |
|---|
| listOrders |
| listCategories |
| listOrderChoices |
| 名称 |
|---|
| showOrder |
| createOrder |
| updateOrder |
| removeOrder |
常见问题
Q：listOrders 与 searchOrders 如何选择？
A：建议统一使用 listOrders。
Q：showOrder 与 showOrderById 如何选择？
A：选择 showOrder，默认需要一个唯一的 params。
Q：在 axios get 方法中使用 params，在 post 方法、put 方法和 delete 方法中使用什么？
A：get、delete 中使用 params，post、put 方法中使用 data。
Q：是否优先配置 baseUrl？
A：是。
Q：如何处理不可数名词作为实体命名规范？
A：如果遇到不可数名词，则需要思考该命名是否合理，默认认为使用了错误的名词命名实体。
params 与 query 参数等的命名
// 不推荐
export function signIn (params = {}) {
if (isUndefined(params.id)) {
throw 'params.id is undefined'
}
return axios({
method: 'POST',
url: `/Sign/SignIn/${params.id}`,
params
})
}
// 不推荐
export function signIn (id, params = {}) {
return axios({
method: 'POST',
url: `/Sign/SignIn/${id}`,
params
})
}
// 推荐
export function signIn ({ id, ...params }) {
return axios({
method: 'POST',
url: `/Sign/SignIn/${id}`,
params
})
}