python写api接口实战

一、操作步骤

1. 导入&＃xff1a;import flask,json


2. 实例化&＃xff1a;api &＃061; flask.Flask(name)


3. 定义接口访问路径及访问方式&＃xff1a;&＃064;api.route(’/index’,methods&＃061;[‘get/post/PUT/DELETE’])


4. 定义函数&＃xff0c;注意需与路径的名称一致&＃xff0c;设置返回类型并支持中文&＃xff1a;def index(): return json.dumps(ren,ensure_ascii&＃061;False)


5. 三种格式入参访问接口&＃xff1a;
   5.1 url格式入参&＃xff1a;flask.request.args.get(‘id’)
   5.2 form-data格式入参&＃xff1a;pwd &＃061; flask.request.values.get(‘pwd’)
   5.3 josn格式入参&＃xff1a;pwd &＃061; flask.request.json.get(‘pwd’)


6. 启动服务&＃xff1a;api.run(port&＃061;8888,debug&＃061;True,host&＃061;‘127.0.0.1’)&＃xff0c;开启服务之后&＃xff0c;就可以通过ip&＃043;端口&＃043;路径&＃043;入参访问接口

二、源码举例

#!/usr/bin/python3
# encoding:utf-8
import flask,json
# 实例化api&＃xff0c;把当前这个python文件当作一个服务&＃xff0c;__name__代表当前这个python文件
api &＃061; flask.Flask(__name__)

# &＃039;index&＃039;是接口路径&＃xff0c;methods不写&＃xff0c;默认get请求
&＃064;api.route(&＃039;/index&＃039;,methods&＃061;[&＃039;get&＃039;])
# get方式访问
def index():
ren &＃061; {&＃039;msg&＃039;:&＃039;成功访问首页&＃039;,&＃039;msg_code&＃039;:200}
#json.dumps 序列化时对中文默认使用的ascii编码.想输出中文需要指定ensure_ascii&＃061;False
return json.dumps(ren,ensure_ascii&＃061;False)

#post入参访问方式一&＃xff1a;url格式参数
&＃064;api.route(&＃039;/article&＃039;,methods&＃061;[&＃039;post&＃039;])
def article():
#url格式参数?id&＃061;12589&name&＃061;&＃039;lishi&＃039;
id &＃061; flask.request.args.get(&＃039;id&＃039;)

if id:
if id &＃061;&＃061; &＃039;12589&＃039;:
ren &＃061; {&＃039;msg&＃039;:&＃039;成功访问文章&＃039;,&＃039;msg_code&＃039;:200}
else:
ren &＃061; {&＃039;msg&＃039;:&＃039;找不到文章&＃039;,&＃039;msg_code&＃039;:400}
else:
ren &＃061; {&＃039;msg&＃039;:&＃039;请输入文章id参数&＃039;,&＃039;msg_code&＃039;:-1}
return json.dumps(ren,ensure_ascii&＃061;False)

#post入参访问方式二&＃xff1a;from-data&＃xff08;k-v&＃xff09;格式参数
&＃064;api.route(&＃039;/login&＃039;,methods&＃061;[&＃039;post&＃039;])
def login():
#from-data格式参数
usrname &＃061; flask.request.values.get(&＃039;usrname&＃039;)
pwd &＃061; flask.request.values.get(&＃039;pwd&＃039;)

if usrname and pwd:
if usrname &＃061;&＃061;&＃039;test&＃039; and pwd &＃061;&＃061;&＃039;123456&＃039;:
ren &＃061; {&＃039;msg&＃039;:&＃039;登录成功&＃039;,&＃039;msg_code&＃039;:200}
else:
ren &＃061; {&＃039;msg&＃039;:&＃039;用户名或密码错误&＃039;,&＃039;msg_code&＃039;:-1}
else:
ren &＃061; {&＃039;msg&＃039;:&＃039;用户名或密码为空&＃039;,&＃039;msg_code&＃039;:1001}
return json.dumps(ren,ensure_ascii&＃061;False)

#post入参访问方式二&＃xff1a;josn格式参数
&＃064;api.route(&＃039;/loginjosn&＃039;,methods&＃061;[&＃039;post&＃039;])
def loginjosn():
#from-data格式参数
usrname &＃061; flask.request.json.get(&＃039;usrname&＃039;)
pwd &＃061; flask.request.json.get(&＃039;pwd&＃039;)

if usrname and pwd:
if usrname &＃061;&＃061;&＃039;test&＃039; and pwd &＃061;&＃061;&＃039;123456&＃039;:
ren &＃061; {&＃039;msg&＃039;:&＃039;登录成功&＃039;,&＃039;msg_code&＃039;:200}
else:
ren &＃061; {&＃039;msg&＃039;:&＃039;用户名或密码错误&＃039;,&＃039;msg_code&＃039;:-1}
else:
ren &＃061; {&＃039;msg&＃039;:&＃039;用户名或密码为空&＃039;,&＃039;msg_code&＃039;:1001}
return json.dumps(ren,ensure_ascii&＃061;False)

if __name__ &＃061;&＃061; &＃039;__main__&＃039;:
api.run(port&＃061;8888,debug&＃061;True,host&＃061;&＃039;127.0.0.1&＃039;) # 启动服务
# debug&＃061;True,改了代码后&＃xff0c;不用重启&＃xff0c;它会自动重启
# &＃039;host&＃061;&＃039;127.0.0.1&＃039;别IP访问地址


运行结果&＃xff1a;

* Serving Flask app &＃039;monitor&＃039; (lazy loading)
* Environment: production
WARNING: This is a development server. Do not use it in a production deployment.
Use a production WSGI server instead.
* Debug mode: on
* Restarting with stat
* Debugger is active!
* Debugger PIN: 991-833-116
* Running on http://127.0.0.1:8888/ (Press CTRL&＃043;C to quit)
127.0.0.1 - - [16/Jan/2022 14:05:53] "POST /login?usrname&＃061;test&pwd&＃061;123456 HTTP/1.1" 200 -
127.0.0.1 - - [16/Jan/2022 14:08:34] "GET /index HTTP/1.1" 200 -


请求方式&＃xff1a;
使用postman测试接口是否可行
如&＃xff1a;
url:127.0.0.1:8888/login
参数&＃xff1a;usrname&＃061;test;pwd&＃061;123456

获取请求参数的几种方法&＃xff1a;

flask.request.form.get("key", type&＃061;str, default&＃061;None) 获取表单数据&＃xff0c;
flask.request.args.get("key") 获取get请求参数&＃xff0c;
flask.request.values.get("key") 获取所有参数。


来源：说笑谈古松