• 使用Flask开发简单接口(1)--GET请求接口


    前言

    很多想学习接口测试的同学,可能在最开始的时候,常常会因没有可以练习的项目而苦恼,毕竟网上可以练习的接口项目不多,有些可能太简单了,有些可能又太复杂了,或者是网上一些免费接口请求次数有限制,最终导致这些同学迟迟无法进行实践。

    就拿我以前在练习JMeter时所用到的接口(相关链接:Jmeter接口测试实例-牛刀小试
    ),因为是网上别人开发的接口,有时候经常因各种原因导致无法正常使用,于是,我就想到为什么不可以自己开发一个简单的接口项目,来满足平常的练习呢?

    因为目前使用Python比较广泛,考虑到Django比较笨重性,而我目前毕竟只是想开发一些简单接口,于是我选择了Flask。Flask是一个使用 Python 编写的轻量级 Web 应用框架,它非常容易上手,我们准备使用它来开发一个简单的接口项目。

    安装Flask

    在Python下,可以直接通过 pip 工具来进行安装,而在我环境下因为同时安装了python2和python3,所以用 pip3 来区分,安装命令:pip3 install Flask,如果想要查看当前Flask版本信息,可以使用命令:pip3 show flask,我目前使用的版本是 1.0.3

    [root@wintest ~]# pip3 show flask
    Name: Flask
    Version: 1.0.3
    Summary: A simple framework for building complex web applications.
    Home-page: https://www.palletsprojects.com/p/flask/
    Author: Armin Ronacher
    Author-email: armin.ronacher@active-4.com
    License: BSD
    Location: /root/python36/lib/python3.6/site-packages
    Requires: itsdangerous, Jinja2, click, Werkzeug
    Required-by: 
    [root@wintest ~]# 
    

    为了更好的学习Flask,我们可以在网上找到Flask的官方文档和中文文档,以便进一步学习。

    Flask官方文档(1.0.x版本):https://flask.palletsprojects.com/en/1.0.x/
    Flask中文文档(最新版):https://dormousehole.readthedocs.io/en/latest/

    最简单的应用

    from flask import Flask
    app = Flask(__name__)
    
    @app.route('/')
    def hello_world():
        return 'Hello, World!'
    

    上面是Flask官方提供的一个最简单的Flask应用,在PyCharm中,我们点击左上方的 file,选择 New Project,创建一个Flask项目。

    创建Flask项目

    在创建的项目中,会存在一个 app.py 文件,该文件里便包含了最简单的Flask应用代码。

    最简单的Flask应用

    我们执行代码启动Flask应用,可以看到如下信息:

    启动Flask

    可以发现,Flask应用的默认端口是 5000,我们打开本地浏览器,输入 http://127.0.0.1:5000/,便可以看到在界面上显示一行内容:Hello World!。

    这是一个最简单的接口,用Flask实现只用了5行代码,可见Flask上手起来并不难。接下来,我们将会使用Flask来开发2个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,用字典将这几个数据存储,并返回显示到页面上。

    如果我们直接把这个定义的字典返回,在请求的时候就会出现报错:TypeError: 'dict' object is not callable,为解决这个问题,我们需要将这样的字典数据转换为JSON字符串,然后才能正常向页面返回。

    一般情况,要返回JSON格式数据,我们可以直接使用 json 模块的 json.dumps() 方法,将字典转换为json字符串,然后返回 。

    # 使用python的json模块
    import json
    json.dumps({"code":"0", "msg":"操作成功", "data":data})
    

    但在Flask中,提供了jsonify方法供用户处理返回的序列化json数据,我们可以直接导入该方法并进行使用。

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

    在这里,我们将直接使用Flask的jsonify方式来处理返回的数据,需要注意的一点,使用该方法会把返回的 Content-Typetext/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数据。。

    设置返回中文数据正常显示

    完成以上内容后,我们运行代码,然后到Chrome浏览器上进行请求。

    中文数据显示不正常

    这里在Chrome浏览器中文显示为了Unicode字符编码,虽然不影响接口的读取,但是可读性不好啊,于是需要在代码中做简单处理,直接加一行代码即可:

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

    最后,再次进行请求,就可以得到想要的数据了。

    获取所有用户信息接口

    获取某个用户信息接口

    不存在用户信息

    源码附上:

    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()
    
    
  • 相关阅读:
    KindEditor-编辑器配置参数属性
    泛型作为返回类型的写法
    ObservableCollection<T> 类
    常遇到的问题
    实现跨浏览器html5表单验证
    mysql 密码重置
    Web用户的身份验证及WebApi权限验证流程的设计和实现
    Discuz3.2 新用户插入数据库SQL
    3. 深入研究 UCenter API 之 加密与解密(转载)
    window.open实现模式窗口
  • 原文地址:https://www.cnblogs.com/wintest/p/12728095.html
Copyright © 2020-2023  润新知