使用Flask开发简单接口(2)--POST请求接口
今天我们继续学习如何使用Flask开发POST接口:用户注册接口和用户登录接口。
request接收参数
当我们在页面发出一个POST请求,请求传到服务器时,需要如何拿到当前请求的数据呢?在Flask可以使用 request
来接收请求参数。
request导入方式
from flask import request
使用 request
来接收参数的方式有多种,比如:
request.form:用于接收表单参数
request.args:用于接收GET参数
request.json:用于接收JSON参数
request.values:获取所有参数(表单参数+GET参数)
request.file:用于接收文件
当然 request
还有不少其他属性,这里就不一一列出了,我们在这里使用了 request.json
和 request.values
来开发POST接口,如果要拿到具体某个参数的值,则是通过 request.json.get("key")
或 request.values.get("key")
来完成。
用户注册接口
@app.route("/register", methods=['POST'])
def user_register():
username = request.json.get("username").strip() # 用户名
password = request.json.get("password").strip() # 密码
sex = request.json.get("sex", "0").strip() # 性别,默认为0(男性)
telephone = request.json.get("telephone", "").strip() # 手机号,默认为空串
address = request.json.get("address", "").strip() # 地址,默认为空串
if username and password and telephone:
if username == "wintest":
return jsonify({"code": 2002, "msg": "用户名已存在!!!"})
elif not (sex == "0" or sex == "1"):
return jsonify({"code": 2003, "msg": "输入的性别只能是 0(男) 或 1(女)!!!"})
elif not (len(telephone) == 11 and re.match("^1[3,5,7,8]\d{9}$", telephone)):
return jsonify({"code": 2004, "msg": "手机号格式不正确!!!"})
else:
return jsonify({"code": 0, "msg": "恭喜,注册成功!"})
else:
return jsonify({"code": 2001, "msg": "用户名/密码/手机号不能为空,请检查!!!"})
在这里,我们接收参数是通过 request.json.get("key")
来实现,在请求的时候,因为直接在浏览器上输入网址访问资源都是GET方式,所以我们可以通过其他工具来模拟,如Postman、Fiddler都可以。
正则表达式
"^1[3,5,7,8]\d{9}$"
简单分析:
^
表示一个字符串的开始
1
表示第一个字符是数字1
[3,5,7,8]
表示第二个字符只是数字 3/5/7/8 中的一个
\d{9}
表示后面后面只能匹配数字,且只能有9位数字
$
表示一个字符串的结束注意:该正则表达式是一个不完全的手机号验证,在这里只能较简单的验证手机号的合法性。
通过Fiddler发送请求模拟:
注意,在这里因为我们没有操作数据库,所以只是返回了注册成功的信息,没有做其他处理。后面引入数据库的时候,应该还需要做其他处理,比如将注册用户信息插入到数据库中,检查 用户/手机号 是否已注册。
用户登录接口
@app.route("/login", methods=['POST'])
def user_login():
username = request.values.get("username")
password = request.values.get("password")
if username and password:
if username == "wintest" and password == "123456":
return jsonify({"code": 0, "msg": "恭喜,登录成功!"})
return jsonify({"code": 1002, "msg": "用户名或密码错误!!!"})
else:
return jsonify({"code": 1001, "msg": "用户名或密码不能为空!!!"})
在这里,我们接收参数是通过 request.values.get("key")
来实现,因为使用了 request.values
,那么我们的请求头参数中,Content-Type
参数就不能用 application/json
了,我们可以使用表单提交的格式:application/x-www-form-urlencoded
,而 body
中参数的格式为:key1=value1&key2=value2
。
这里也可以把请求数据写到请求路径下:
OK,以上我们使用Flask开发了2个简单的POST请求接口,但并没有连接到数据库进行操作,比如用户注册/登录接口中,验证的用户名都是固定的,不够灵活。下一节,我们将引入数据库来进一步完善。
源码附上:
from flask import Flask, jsonify, request
app = Flask(__name__)
app.config["JSON_AS_ASCII"] = False # jsonify返回的中文正常显示
@app.route("/register", methods=['POST'])
def user_register():
username = request.json.get("username").strip() # 用户名
password = request.json.get("password").strip() # 密码
sex = request.json.get("sex", "0").strip() # 性别,默认为0(男性)
telephone = request.json.get("telephone", "").strip() # 手机号,默认为空
address = request.json.get("telphone", "").strip() # 地址,默认为空
if username and password and telephone:
import re
if username == "wintest":
return jsonify({"code": 2002, "msg": "用户名已存在!!!"})
elif not (sex == "0" or sex == "1"):
return jsonify({"code": 2003, "msg": "输入的性别只能是 0(男) 或 1(女)!!!"})
elif not (len(telephone) == 11 and re.match("^1[3,5,7,8]\d{9}$", telephone)):
return jsonify({"code": 2004, "msg": "手机号格式不正确!!!"})
else:
return jsonify({"code": 0, "msg": "恭喜,注册成功!"})
else:
return jsonify({"code": 2001, "msg": "用户名/密码/手机号不能为空,请检查!!!"})
@app.route("/login", methods=['POST'])
def user_login():
username = request.values.get("username")
password = request.values.get("password")
if username and password:
if username == "wintest" and password == "123456":
return jsonify({"code": 0, "msg": "恭喜,登录成功!"})
return jsonify({"code": 1002, "msg": "用户名或密码错误!!!"})
else:
return jsonify({"code": 1001, "msg": "用户名或密码不能为空!!!"})
if __name__ == '__main__':
app.run()