接口文档-示例

接口文档-示例

1 根据ID查询员工

1.1 基本信息

请求路径：/emp

请求方式：GET

接口描述：该接口用于根据ID查询员工信息

1.2 请求参数

参数说明：

参数名	类型	是否必须	备注
id	number	必须	员工ID

请求样例：

GET	http://localhost:8080/emp?id=15

1.3 响应数据

参数格式：application/json

参数说明：

名称	类型	是否必须	备注	其他信息
code	number	必须	响应码, 1 成功 , 0 失败
msg	string	非必须	提示信息
data	object	必须	返回的数据
|- id	number	非必须	id
|- name	string	非必须	姓名
|- gender	number	非必须	性别 , 1 男 ; 2 女
|- image	string	非必须	图像
|- job	number	非必须	职位
|- entrydate	string	非必须	入职日期
|- updateTime	string	非必须	更新时间

响应数据样例：

{
    "code": 1,
    "message": "success",
    "data": {
        "id": 15,
        "name": "谢逊",
        "image": "https://web-framework.oss-cn-hangzhou.aliyuncs.com/web/1.jpg",
        "gender": 1,
        "job": "班主任",
        "entrydate": "2008-05-09",
        "updatetime": "2022-10-01 12:00:00"
    }
}