当前位置：首页 > article >正文

Flask接口开发--GET接口

article 2025/3/26 0:51:02

安装Flask

1.安装命令：

pip3 install Flask

2.查看Flask版本：

pip3 show flask

如图我的Flask版本号是2.0.3
在这里插入图片描述

项目创建

1、在PyCharm中，我们点击左上方的 file，选择 New Project，创建一个Flask项目。（Pycharm社区版创建Flask项目）
在这里插入图片描述
2、在创建的项目中，会存在一个 app.py 文件，该文件里便包含了最简单的Flask应用代码。

3、执行app.py的main函数，浏览器输入 http://127.0.0.1:5000/，便可以看到在界面上显示一行内容：Hello World!。
这是最简单的接口。

准备get请求的用户数据

我们创建一个 Python包，包名设置为 api ，表示将用于存放后续编写的接口。在该包下新建一个 user.py 文件，这个文件用于编写用户相关的接口。

data = [
    {"id": 1, "username": "小明", "password": "123456", "role": 0, "sex": 0, "telephone": "10086", "address": "北京市海淀区"},
    {"id": 2, "username": "李华", "password": "abc", "role": 1, "sex": 0, "telephone": "10010", "address": "广州市天河区"},
    {"id": 3, "username": "大白", "password": "666666", "role": 0, "sex": 1, "telephone": "10000", "address": "深圳市南山区"}
]

上面是我们准备的用户数据，因为我们暂没用到数据库，所以自己定义了一个列表，列表下存放多个用户信息，而每个用户信息，则通过字典来存储。每个字典均含有 id、username、password、telphone、address 等键名和键值。

通过jsonify返回JSON格式数据

我们在接口返回数据时，我们会定义一个字典，设置了接口返回码code、接口返回信息msg、返回数据实体data，用字典将这几个数据存储，并返回显示到页面上。
Flask中，提供了jsonify方法供用户处理返回的序列化json数据，我们可以直接导入该方法并进行使用。

# 使用Flask的jsonify方式
from flask import Flask,jsonify
jsonify({"code":"0", "msg":"操作成功", "data":data})

在这里，我们将直接使用Flask的jsonify方式来处理返回的数据，需要注意的一点，使用该方法会把返回的 Content-Type 从 text/html 转换成带json特征的 application/json。

获取所有用户信息接口

@app.route("/users", methods=["GET"])
def get_all_users():
    """获取所有用户信息"""
    return jsonify({"code":"0", "data":data, "msg":"操作成功"})

这里的代码表示，当我们在请求路径为 /users ，且请求方法为GET方式时，才会执行 get_all_users 接口，最后才能返回JSON数据。

Flask的请求默认是GET请求，也就是说 @app.route() 中，我们可以不写 methods 参数，但这样只能通过GET方式来发出请求。如果需要支持其他的请求方式，那么这里的 methods 需要写成一个列表，当然也可以同时支持 GET、POST等请求方式，比如 methods=[“GET”, “POST”] 表示既支持GET方式也支持POST方式的请求。

获取某个用户信息接口

@app.route("/users/<int:user_id>", methods=["GET"])
def get_user(user_id):
    """获取某个用户信息"""
    if user_id > 0 and user_id <= len(data):
        return jsonify({"code": "0", "data": data[user_id - 1], "msg": "操作成功"})
    return jsonify({"code": "1", "msg": "用户不存在"})

在这里，我们的请求URL中有变量（因为需要获取指定的用户信息），对于变量，我们需要使用 <> ，如 <user_id>，这样就可以将这些特殊部分标记为变量名。

在上面代码中，我们使用的是 int:user_id，这里用到了Flask自带的路由转换器 int，表示接收到的 user_id 是整数类型，如果不加的话，那么就默认是 string 转换器。

而我们获取到指定的用户信息，则是用 data[user_id - 1] 来实现，比如要获取到data中第2条用户信息，那么用data[1]就可以得到，另外，如果请求的 user_id 不在当前范围的，则是直接返回用户不存在的JSON数据。

数据请求

1、运行get_api.py
在这里插入图片描述
2、查询所有用户：http://127.0.0.1:5000/users

3、查询某一个用户（存在）：

4、查询某一个用户（不存在）：

完整源码：

from flask import Flask, jsonify

app = Flask(__name__)
app.config["JSON_AS_ASCII"] = False  # jsonify返回的中文正常显示

data = [
    {"id": 1, "username": "小明", "password": "123456", "role": 0, "sex": 0, "telephone": "10086", "address": "北京市海淀区"},
    {"id": 2, "username": "李华", "password": "abc", "role": 1, "sex": 0, "telephone": "10010", "address": "广州市天河区"},
    {"id": 3, "username": "大白", "password": "666666", "role": 0, "sex": 1, "telephone": "10000", "address": "深圳市南山区"}
]
@app.route('/')
def hello_world():
    return 'Hello World!'

@app.route("/users", methods=["GET"])
def get_all_users():
    """获取所有用户信息"""
    return jsonify({"code": "0", "data": data, "msg": "操作成功"})

@app.route("/users/<int:user_id>", methods=["GET"])
def get_user(user_id):
    """获取某个用户信息"""
    if user_id > 0 and user_id <= len(data):
        return jsonify({"code": "0", "data": data[user_id - 1], "msg": "操作成功"})
    return jsonify({"code": "1", "msg": "用户不存在"})

if __name__ == '__main__':
    app.run()