# pet-api-server

**Repository Path**: Five_classmates/pet-api-server

## Basic Information

- **Project Name**: pet-api-server
- **Description**: 宠物领养项目所用到的接口以及文档。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-01-12
- **Last Updated**: 2023-05-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 接口文档

## 注册接口
### 简要描述
1. 用户注册接口

### 请求方式
- post

### 请求URL
-  /api/register

- 请求体

|  参数名 | 必选  |  类型 |  说明 |  
|---|---|---|---|
|  telphone | 是  | string  |  手机号  |
|  password |  是 |  string  |  密码 |


### 返回示例
```
    {
        "status:" 0,
         "message:" "注册成功"
    }
```

### 返回参数说明

| 参数名  | 类型  | 说明  |
|---|---|---|
| status  |  int |  请求是否成功，0:成功，1:失败 |
| message  |  string |  请求结果描述信息


-------------------------------------------------------


## 登陆接口
### 简要描述
1. 用户注册接口

### 请求方式
- post

### 请求URL
-  /api/login

- 请求体

|  参数名 | 必选  |  类型 |  说明 |  
|---|---|---|---|
|  telphone | 是  | string  |  手机号  |
|  password |  是 |  string  |  密码 |


### 返回示例
```
  {
    "status": 0,
    "message": "登录成功！",
    "token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo5LCJ0ZWxwaG9uZSI6IjE1MzIwMjE1NTI1Iiwibmlja25hbWUiOiLlnIblnIYiLCJwYXNzd29yZCI6IiIsImdlbmRlciI6IueUtyIsInJlZ2lzdGVyX3RpbWUiOm51bGwsImF2YXRhciI6IiIsImlhdCI6MTY3MzcwODU4OCwiZXhwIjoxNjczODgxMzg4fQ.BQd5OOrOi7cY0aNX6CkzIIfiwjPbKH7TVZTValxz_A"
}
```

### 返回参数说明

| 参数名  | 类型  | 说明  |
|---|---|---|
| status  |  int |  请求是否成功，0:成功，1:失败 |
| message  |  string |  请求结果描述信息|
| token  |  string |  用于有权限接口的身份认证|



-------------------------------------------------------




## 获取用户的基本信息
### 简要描述
1. 获取用户的基本信息

### 请求方式
- get

### 请求URL
-  /my/userinfo

### Header

```
Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoiIiwibmlja25hbWUiOiLms6Xlt7Tlt7QiLCJlbWFpbCI6Im5pYmFiYUBpdGNhc3QuY24iLCJ1c2VyX3BpYyI6IiIsImlhdCI6MTU3ODAzNjY4MiwiZXhwIjoxNTc4MDcyNjgyfQ.Mwq7GqCxJPK-EA8LNrtMG04llKdZ33S9KBL3XeuBxuI

```


### 返回示例
```
 {
    "status": 0,
    "message": "获取用户基本信息成功！",
    "data": {
        "telphone": "15320215525",
        "nickname": "圆圆",
        "avatar": "/upload/1.png"
    }
}
```

### 返回参数说明

| 参数名  | 类型  | 说明  |
|---|---|---|
| status  |  int |  请求是否成功，0:成功，1:失败 |
| message  |  string |  请求结果描述信息|
| data  |  object |  返回数据|




-------------------------------------------------------




## 更改用户基本信息
### 简要描述
1. 更改用户的基本信息

### 请求方式
- post

### 请求URL
-  /my/userinfo

### Header

```
Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoiIiwibmlja25hbWUiOiLms6Xlt7Tlt7QiLCJlbWFpbCI6Im5pYmFiYUBpdGNhc3QuY24iLCJ1c2VyX3BpYyI6IiIsImlhdCI6MTU3ODAzNjY4MiwiZXhwIjoxNTc4MDcyNjgyfQ.Mwq7GqCxJPK-EA8LNrtMG04llKdZ33S9KBL3XeuBxuI

```


### 返回示例
```
{
    "status": 0,
    "message": "修改用户基本信息成功！"
}
```

### 返回参数说明

| 参数名  | 类型  | 说明  |
|---|---|---|
| status  |  int |  请求是否成功，0:成功，1:失败 |
| message  |  string |  请求结果描述信息|



-------------------------------------------------------




## 重置用户密码
### 简要描述
1. 重置密码
### 请求方式
- post

### 请求URL
-  /my/updatepwd
### Header

```
Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoiIiwibmlja25hbWUiOiLms6Xlt7Tlt7QiLCJlbWFpbCI6Im5pYmFiYUBpdGNhc3QuY24iLCJ1c2VyX3BpYyI6IiIsImlhdCI6MTU3ODAzNjY4MiwiZXhwIjoxNTc4MDcyNjgyfQ.Mwq7GqCxJPK-EA8LNrtMG04llKdZ33S9KBL3XeuBxuI

```


### 返回示例
```
{
    "status": 0,
    "message": "更新密码成功！"
}```

### 返回参数说明

| 参数名  | 类型  | 说明  |
|---|---|---|
| status  |  int |  请求是否成功，0:成功，1:失败 |
| message  |  string |  请求结果描述信息|





-------------------------------------------------------




## 更换头像
### 简要描述
1. 更换用户的头像
### 请求方式
- post

### 请求URL
-  /my/update/avatar
### Header

```
Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoiIiwibmlja25hbWUiOiLms6Xlt7Tlt7QiLCJlbWFpbCI6Im5pYmFiYUBpdGNhc3QuY24iLCJ1c2VyX3BpYyI6IiIsImlhdCI6MTU3ODAzNjY4MiwiZXhwIjoxNTc4MDcyNjgyfQ.Mwq7GqCxJPK-EA8LNrtMG04llKdZ33S9KBL3XeuBxuI

```


### 返回示例
```
{
    "status": 0,
    "message": "更换头像成功"
}```

### 返回参数说明

| 参数名  | 类型  | 说明  |
|---|---|---|
| status  |  int |  请求是否成功，0:成功，1:失败 |
| message  |  string |  请求结果描述信息|