Flask-API接口文档

目录

1. 获取城市接口

2. 注册接口

---

1. 获取城市接口

接口功能

获取所有城市数据

URL

http://127.0.0.1:5000/city/

支持格式

JSON

HTTP请求方式

GET

请求参数

无

返回字段

返回字段	字段类型	说明
returnCode	string	返回结果状态。0：正常；-1：错误。
returnValue	object	所有城市数据

接口示例

地址：http://127.0.0.1:5000/city/

<pre spellcheck="false" class="md-fences md-end-block ty-contain-cm modeLoaded" lang="javascript" contenteditable="false" cid="n44" mdtype="fences" style="box-sizing: border-box; overflow: visible; font-family: var(--monospace); font-size: 0.9em; display: block; break-inside: avoid; text-align: left; white-space: normal; background-image: inherit; background-position: inherit; background-size: inherit; background-repeat: inherit; background-attachment: inherit; background-origin: inherit; background-clip: inherit; background-color: rgb(248, 248, 248); position: relative !important; border: 1px solid rgb(231, 234, 237); border-radius: 3px; padding: 8px 1em 6px; margin-bottom: 15px; margin-top: 15px; width: inherit; color: rgb(51, 51, 51); font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">{
"returnCode": "0",
"returnValue": {
"A": [
{
"id": 333,
"parentId": 0，
"regionName": "深圳",
"cityCode": 45454,
"pinYin": "Shenzhen"
},
...
],
"B": [
...
]
}
}
​</pre>

2. 注册接口

接口功能

用户注册

URL

http://127.0.0.1:5000/register/

支持格式

JSON

HTTP请求方式

POST

请求参数

参数名	是否必须	类型	说明
username	True	string	用户名
password	True	string	密码
email	True	string	邮箱

返回字段

返回字段	字段类型	说明
returnCode	string	返回结果状态。0：正常；-1：错误,。
returnValue	object	返回的用户数据
msg	string	状态说明

接口示例

地址：http://127.0.0.1:5000/register/

<pre spellcheck="false" class="md-fences md-end-block ty-contain-cm modeLoaded" lang="javascript" contenteditable="false" cid="n103" mdtype="fences" style="box-sizing: border-box; overflow: visible; font-family: var(--monospace); font-size: 0.9em; display: block; break-inside: avoid; text-align: left; white-space: normal; background-image: inherit; background-position: inherit; background-size: inherit; background-repeat: inherit; background-attachment: inherit; background-origin: inherit; background-clip: inherit; background-color: rgb(248, 248, 248); position: relative !important; border: 1px solid rgb(231, 234, 237); border-radius: 3px; padding: 8px 1em 6px; margin-bottom: 15px; margin-top: 15px; width: inherit; color: rgb(51, 51, 51); font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">{
"returnValue": {
"username": "lisi3",
"is_active": false,
"utoken": "64c57c33-ab0f-4093-a4ea-21c82e18b90b",
"email": "5566@qq.com"
},
"returnCode": "0",
"msg": "success"
}
​</pre>

3. 登录接口

接口功能

用户登录

URL

http://127.0.0.1:5000/login/

支持格式

JSON

HTTP请求方式

POST

请求参数

参数名	是否必须	类型	说明
username	True	string	用户名
password	True	string	密码

返回字段

返回字段	字段类型	说明
returnCode	string	返回结果状态。0：正常；-1：用户未激活， -2：密码错误， -3：用户不存在。
returnValue	object	用户数据
msg	string	状态说明

接口示例

地址：http://127.0.0.1:5000/login/

<pre spellcheck="false" class="md-fences md-end-block ty-contain-cm modeLoaded" lang="javascript" contenteditable="false" cid="n157" mdtype="fences" style="box-sizing: border-box; overflow: visible; font-family: var(--monospace); font-size: 0.9em; display: block; break-inside: avoid; text-align: left; white-space: normal; background-image: inherit; background-position: inherit; background-size: inherit; background-repeat: inherit; background-attachment: inherit; background-origin: inherit; background-clip: inherit; background-color: rgb(248, 248, 248); position: relative !important; border: 1px solid rgb(231, 234, 237); border-radius: 3px; padding: 8px 1em 6px; margin-bottom: 15px; margin-top: 15px; width: inherit; color: rgb(51, 51, 51); font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">{
"returnCode": "0",
"msg": "success",
"returnValue": {
"utoken": "956927d1-3ecd-44d7-aecc-2f9bf4e9835d",
"is_active": true,
"email": "904552498@qq.com",
"name": "wangwu"
}
}
​</pre>