定义API

这里的API定义指在/api/目录中创建js文件来定义业务中的API.这里的API将会在业务层中调用. 我们应该遵循以下实践规则:

• API的文件定义与API文档中的模块保持一致,这样的好处是无论是在类似yAPI中查阅调试API时或者查阅API文档时,代码中的API结构始终是和其他部分完全一样.
• API的文件名称应与API文档中定义的模块保持一致.
• API的书写应保持在同一项目中保持统一

[info] 关于RESTful

如果你的项目使用了REST规范,则请在定义API时遵循其定义规则.

示例

import http from '@/utils/http'

/**
 * 用户列表
 * @export
 * @params { any } params
 * @returns { promise }
 */
export function GetUsers (params) {
    return http.post(
        '/user/userList',
        params
    )
}

/**
 * 获取用户信息
 *
 * @export
 * @param {any} params
 * @returns
 */
export function GetUserInfo (userId) {
  return http.post(
    '/user/info',
    { userId }
  )
}