# api-frame

**Repository Path**: dzlua/api-frame

## Basic Information

- **Project Name**: api-frame
- **Description**: flask restful api frame

- **Primary Language**: Python
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2017-10-22
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# api-frame
flask restful api frame

### 1. 注册

```
> curl -X POST -d "username=dzlua&password=dzlua&email=505544956@qq.com" http://127.0.0.1:5000/api/register_email

{"status": {"code": 200, "message": "OK"}, "data": "dzlua"}
```

### 2. 获取token/登录

```
> curl -X POST -u dzlua:dzlua http://127.0.0.1:5000/api/login

{"status": {"code": 200, "message": "OK"}, "data": {"refresh_token": "eyJhbGciOiJIUzI1NiIsImlhdCI6MTU2MTQ0Njg1NiwiZXhwIjoxNTYxNTMzMjU2fQ.eyJkYXRhIjp7InVzZXJfaWQiOjF9LCJ0eXBlIjoicmVmcmVzaF90b2tlbiIsImdlbmVyYXJlX3RpbWUiOjE1NjE0NDY4NTYsImV4cGlyZXNfaW4iOjg2NDAwLCJ1dWlkIjoiZDc2YmM2NmUtOTcxOC0xMWU5LWE4ODgtNDBiMDc2ODAyOTc0In0.tMdUhZL3ukYbT4o263JZ0RA6BWV8cIFMqCklN6eHAFI", "refresh_expires_in": 86400, "access_token": "eyJhbGciOiJIUzI1NiIsImlhdCI6MTU2MTQ0Njg1NiwiZXhwIjoxNTYxNDQ3NDU2fQ.eyJkYXRhIjp7InVzZXJfaWQiOjF9LCJ0eXBlIjoiYWNjZXNzX3Rva2VuIiwiZ2VuZXJhcmVfdGltZSI6MTU2MTQ0Njg1NiwiZXhwaXJlc19pbiI6NjAwLCJ1dWlkIjoiZDc2ZDkxN2EtOTcxOC0xMWU5LWJjNjAtNDBiMDc2ODAyOTc0In0.rILvCodz6vvYLGP960LadigbGEiDN3VtTZDPzzhmnhE", "access_expires_in": 600, "username": "dzlua"}}

```

### 3. 使用token

##### 1. 使用access_token获取所有的用户
```
> curl -X POST -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsImlhdCI6MTU2MTQ0Njg1NiwiZXhwIjoxNTYxNDQ3NDU2fQ.eyJkYXRhIjp7InVzZXJfaWQiOjF9LCJ0eXBlIjoiYWNjZXNzX3Rva2VuIiwiZ2VuZXJhcmVfdGltZSI6MTU2MTQ0Njg1NiwiZXhwaXJlc19pbiI6NjAwLCJ1dWlkIjoiZDc2ZDkxN2EtOTcxOC0xMWU5LWJjNjAtNDBiMDc2ODAyOTc0In0.rILvCodz6vvYLGP960LadigbGEiDN3VtTZDPzzhmnhE" http://127.0.0.1:5000/api/users

{"status": {"code": 200, "message": "OK"}, "data": ["dzlua", "dzlua1"]}
```

##### 2. 使用access_token获取用户的详细信息
```
> curl -X POST -d "username=dzlua" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsImlhdCI6MTU2MTQ0Njg1NiwiZXhwIjoxNTYxNDQ3NDU2fQ.eyJkYXRhIjp7InVzZXJfaWQiOjF9LCJ0eXBlIjoiYWNjZXNzX3Rva2VuIiwiZ2VuZXJhcmVfdGltZSI6MTU2MTQ0Njg1NiwiZXhwaXJlc19pbiI6NjAwLCJ1dWlkIjoiZDc2ZDkxN2EtOTcxOC0xMWU5LWJjNjAtNDBiMDc2ODAyOTc0In0.rILvCodz6vvYLGP960LadigbGEiDN3VtTZDPzzhmnhE" http://127.0.0.1:5000/api/info

{"status": {"code": 200, "message": "OK"}, "data": {"username": "dzlua", "email": "505544956@qq.com", "phone": null, "email_verifyed": false, "phone_verifyed": false}}
```

### 4. 退出

##### 1. 使用密码退出

```
> curl -X POST -u dzlua:dzlua http://127.0.0.1:5000/api/logout

{"status": {"code": 200, "message": "OK"}, "data": "logout"}
```

##### 2. 使用refresh_token退出

```
> curl -X POST -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsImlhdCI6MTU2MTQ0Njg1NiwiZXhwIjoxNTYxNTMzMjU2fQ.eyJkYXRhIjp7InVzZXJfaWQiOjF9LCJ0eXBlIjoicmVmcmVzaF90b2tlbiIsImdlbmVyYXJlX3RpbWUiOjE1NjE0NDY4NTYsImV4cGlyZXNfaW4iOjg2NDAwLCJ1dWlkIjoiZDc2YmM2NmUtOTcxOC0xMWU5LWE4ODgtNDBiMDc2ODAyOTc0In0.tMdUhZL3ukYbT4o263JZ0RA6BWV8cIFMqCklN6eHAFI" http://127.0.0.1:5000/api/logout

status": {"code": 200, "message": "OK"}, "data": "logout"}
```