一、前言

很多时候为了提高软件开发的效率,后端程序人员理想状态下应该编写程序测试接口供前端程序人员进行测试,以便前端的开发。笔者由于项目的需求近期尝试学习了一下测试接口的编写,以Python+Flask框架作为编写工具,并以eolinker作为程序接口的测试工具,最终实现程序接口测试功能。

二、程序接口编写

由于接口的编写框架使用的是flask框架(Flask框架和Django框架是两个比较常用的web框架),Flak框架官网解释是一个轻量级的Web应用框架,而Django框架官网的解释是高水准(重量级)的Python编程语言驱动的一个开源模型。选择哪个框架由项目需求而定,由于笔者是网页开发的小白,为了灵活方便决定选用Flask框架作为Web开发工具。

Falsk框架的pip安装
在cmd中使用pip安装Flask框架,代码如下:

pip install flask

使用Flask框架进行接口编写
下面以加法功能作为例子,用Flask框架把函数写成接口。程序和解释如下:

#首先导入接口编写过程中所需要的库,Flask是框架函数,
#使用request的函数目的是把请求的参数转换为json格式,
#使用jsonify的目的是把返回的参数转换发json格式

from flask import Flask, request, jsonify

#首先把接口实例化
app = Flask(__name__)

#需要实现调用的功能函数
def add(x,y):
    z = x + y
    return z

#使用post的方法对接口进行访问
#绑定路由,本机的服务地址是:http://127.0.0.1
#如果使用8080作为端口,/add为自己设定的路径,可以理解为文件夹,
# 那么下面这个例子通过自己设定的路由的IP地址为:http://127.0.0.1:8080/add
@app.route('/add', methods=["POST"])

#路由设置完毕后就可以开始编写接口函数
def calculate():
    params = request.get_json()  #通过get_json()把发送过来的参数转变为json格式
    print(params)
    x = params['x']  #json的格式类似于字典,因此可以用键值的方式进行提取
    y = params['y']
    z = add(x=x,y=y)  #调用函数获取计算结果

    res = {"加法结果": z} #为了把返回结果进行json格式转换,先把它表达成字典的形式
    return jsonify(res)  #使用jsonify函数把res转换为json格式并进行返回

#接口编写完毕,通过add.run开启服务器接口
# host='0.0.0.0'意思是设置为可在任何主机上运行,port为使用的端口名称
if __name__ == '__main__':
    app.run(host='0.0.0.0',
            threaded=True,
            debug=True,
            port=8080)

那么经过上面的程序,接口就编写完毕了,接下来通过eolinker对接口进行测试。

三、程序接口测试

eolinker的接口创建方法

首先打开eolinker程序,新建一个API,主要填写一下两个部分,界面如下:

1、API地址填写

Python flask开多个连接 python flask接口_Python flask开多个连接


2、请求参数输入设置

Python flask开多个连接 python flask接口_http_02


以上步骤填写完毕后按保存功能测试接口就完成。界面图片如下:

Python flask开多个连接 python flask接口_接口_03

eolinker的接口测试方法

1、打开服务器,如果是本机的话,可以通过在pycham上运行接口程序打开服务器,界面如下:

Python flask开多个连接 python flask接口_json_04

2、在eolinker已创建的接口上输入参数进行测试,界面如下:

Python flask开多个连接 python flask接口_Python flask开多个连接_05


3、点击发送或测试,获取返回参数,也就是程序设置的计算返回结果,界面如下:

Python flask开多个连接 python flask接口_python_06

四、总结

那么通过以上步骤,基于python的Flask框架写json接口并且结合eolinker进行接口测试的功能已经完成,希望能对大家有所帮助。