2022年 11月 5日

Python接口开发实现步骤详解

更多编程教程请到:菜鸟教程 https://www.piaodoo.com/

友情链接:

高州阳光论坛https://www.hnthzk.com/

人人影视http://www.sfkyty.com/

一、操作步骤

1. 导入:import flask,json
2. 实例化:api = flask.Flask(__name__)
3. 定义接口访问路径及访问方式:@api.route(‘/index’,methods=[‘get/post/PUT/DELETE’])
4. 定义函数,注意需与路径的名称一致,设置返回类型并支持中文:def index(): return json.dumps(ren,ensure_ascii=False)
5. 三种格式入参访问接口:
5.1 url格式入参:flask.request.args.get(‘id’)
5.2 form-data格式入参:pwd = flask.request.values.get(‘pwd’)
5.3 josn格式入参:pwd = flask.request.json.get(‘pwd’)
6. 启动服务:api.run(port=8888,debug=True,host=’127.0.0.1′),开启服务之后,就可以通过ip+端口+路径+入参访问接口

二、源码举例

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

‘index’是接口路径,methods不写,默认get请求

@api.route(’/index’,methods=[‘get’])

get方式访问

def index():
ren = {‘msg’:‘成功访问首页’,‘msg_code’:200}
#json.dumps 序列化时对中文默认使用的ascii编码.想输出中文需要指定ensure_ascii=False
return json.dumps(ren,ensure_ascii=False)

#post入参访问方式一:url格式参数
@api.route(’/article’,methods=[‘post’])
def article():
#url格式参数?id=12589&name=‘lishi’
id = flask.request.args.get(‘id’)

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

#post入参访问方式二:from-data(k-v)格式参数
@api.route(’/login’,methods=[‘post’])
def login():
#from-data格式参数
usrname = flask.request.values.get(‘usrname’)
pwd = flask.request.values.get(‘pwd’)

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

#post入参访问方式二:josn格式参数
@api.route(’/loginjosn’,methods=[‘post’])
def loginjosn():
#from-data格式参数
usrname = flask.request.json.get(‘usrname’)
pwd = flask.request.json.get(‘pwd’)

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

if name == ‘main’:
api.run(port=8888,debug=True,host=‘127.0.0.1’) # 启动服务

debug=True,改了代码后,不用重启,它会自动重启

‘host=’127.0.0.1’别IP访问地址

运行结果

* Serving Flask app “restful” (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: 249-915-285
* Running on http://127.0.0.1:8888/ (Press CTRL+C to quit)

三、postman访问接口

get方式,无参数访问接口

post方式,url格式入参访问接口

post方式,form-data格式入参访问接口

post方式,josn格式入参访问接口

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持菜鸟教程www.piaodoo.com。