paopao/docs/api doc/获取用户个人信息接口.md
2024-05-21 15:16:42 +08:00

95 lines
2.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## 1. 获取用户个人信息接口
### 1.1 接口描述
获取当前登录用户的个人信息。
### 1.2 请求URL
`/v1/user/info`
### 1.3 请求方式
**GET**
### 1.4 请求头
| 头字段 | 必填 | 数据类型 | 描述 |
| ------------ | ---- | ------------- | -------------------------------- |
### 1.5 请求体参数
| 参数名称 | 必填 | 数据类型 | 约束条件 | 描述 | 示例 | 允许空值 |
|-----------| ---- | -------- | -------- | ---------------------------- | ------------ | -------- |
### 1.6 请求示例
```http
GET /v1/user/info
```
### 1.7 返回参数说明
| 参数名称 | 必填 | 数据类型 | 约束条件 | 描述 |
|------| ---- | -------- | -- |-----------|
| code | 是 | 整型 | | 错误码0表示成功 |
| msg | 否 | 字符串 | | 错误信息描述 |
| data | 否 | json | | 具体业务数据 |
data结构说明
| 参数名称 | 必填 | 数据类型 | 约束条件 | 描述 |
|----------| --- | -------- |--|------|
| id | 是 | 整型 | | 用户id |
| username | 是 | 字符串 | 1-32字符 | 登录账号 |
| ... | | | | |
| follows | 是 | 整型 | | 关注我的 |
| followings | 是 | 整型 | | 我关注的 |
| tweets_count | 是 | 整型 | | |
### 1.8 响应示例(成功)
```json
{
"code": 0,
"msg": "success",
"data": {
"id": 100066,
"nickname": "xyz",
"username": "xyz",
"status": 1,
"avatar": "https://assets.paopao.info/public/avatar/default/jackson.png",
"phone": "",
"is_admin": false,
"created_on": 1714290963,
"follows": 0,
"followings": 0,
"tweets_count": 4
}
}
```
### 1.9 响应示例(错误)
```json
{ "code": 500, "msg": "内部错误" }
```
### 1.10 错误响应码参考
更多响应错误码及含义,请参阅[API响应码表](URL/for/api/responseCode/table)。
### 1.11 安全性与认证
### 1.12 测试环境
访问测试环境以进行接口调试:
[https://test.apiAddress.com](https://test.apiAddress.com)
### 1.13 版本管理
本API通过URI路径进行版本控制。请在请求URL中包含`/v1`以使用当前版本。
### 1.14 更新记录
- **2024-05-07**添加data结构说明
- **2024-04-29**:发布文档初始版本。
### 1.15 联系支持
如需帮助或对API有任何疑问请通过电子邮件与我们联系[support@api.com](mailto:support@api.com)。
### 1.16 反馈与建议
发现文档问题或有改进建议?请填写[反馈表单](https://forms.api.com/feedback)与我们分享。