APP API接口文档模板
1、接口名称: 用户信息获取
2、接口地址:/api/user/info
3、请求方法:GET
4、接口版本:v1.0
5、更新时间:2024-07-01
6、接口作者:张三
7、接口描述: 该接口用于获取当前登录用户的基本信息,包括用户名、邮箱、注册时间等。
请求参数
参数名 | 类型 | 必填 | 默认值 | 描述 |
userId | String | 是 | null | 用户ID |
URL参数示例
/api/user/info?userId=12345
请求头
名称 | 类型 | 必填 | 默认值 | 描述 |
Authorization | String | 是 | null | JWT Token |
Content-Type | String | 是 | application/json | 内容类型 |
响应参数
字段名 | 类型 | 描述 |
statusCode | Integer | 响应状态码,200成功,其他失败 |
message | String | 响应消息 |
data | Object | 用户详细信息对象 |
data对象结构
字段名 | 类型 | 描述 |
username | String | 用户名 |
String | 用户邮箱 | |
registerTime | String | 注册时间 |
返回示例
{ "statusCode": 200, "message": "Success", "data": { "username": "testUser", "email": "testuser@example.com", "registerTime": "2024-01-01T12:00:00Z" } }
异常返回示例
{ "statusCode": 404, "message": "User not found", "data": null }
以上就是关于“app api接口文档模板”的问题,朋友们可以点击主页了解更多内容,希望可以够帮助大家!
原创文章,作者:K-seo,如若转载,请注明出处:https://www.kdun.cn/ask/705878.html