Python restful框架接口开发实现


Posted in Python onApril 13, 2020

理解

  • 每一个URL代表一种资源
  • 客户端和服务端之间,传递这种资源的某种表现层,客户端通过四个HTTP动词
  • 对服务端资源进行操作,实现“表现层状态转化”
  • 资源:网络的具体信息,如图片、文字等
  • 表现层:"资源"是一种信息实体,它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式,如,文本可以用txt格式表现,也可以用HTML格式、XML格式、JSON格式表现
  • 状态转化:访问一个网站,就代表了客户端和服务器的一个互动过程。在这个过程中,势必涉及到数据和状态的变化。
  • 4个HTTP动词:GET用来获取资源,POST用来新建资源(也可以用于更新资源),PUT用来更新资源,DELETE用来删除资源。

安装 flask restful

1.cmd输入:pip install flask,安装flask

2.cmd输入:pip install flask-restful,安装flask-restful

安装过程中会出现如下报错:

You are using pip version 9.0.1, however version 19.2.3 is available. You should consider upgrading via the 'python -m pip install --upgrade pip' comm and.

解决方法

升级pip python -m pip install --upgrade pip

注意:某些Flask版本下,引入模块时采用from flask.ext.restful import Api出错,则可以使用from flask_restful import Api

官网教程

例证

restful.py 内容:

#!/usr/bin/python3
# encoding:utf-8
from flask import Flask,request
from flask_restful import reqparse, abort, Api, Resource

#初始化app、api
app = Flask(__name__)
api = Api(app)

LISTS = [
  {'parameter': '首页'},
  {'parameter': '登录'},
  {'parameter': '后台'}
]

# /LISTS/<list_id>(url参数),判断输入的参数值列表LISTS下标越界,越界则退出
def abort_if_list_doesnt_exist(list_id):
  try:
    LISTS[list_id]
  except IndexError:
    abort(404, message="输入的值,不在范围内")
'''
add_argument('per_page', type=int, location='args') str
add_argument中通过指定参数名、参数类型、参数获取方式来获取参数对象并支持做合法性校验
第一个参数是需要获取的参数的名称
参数type: 参数指的类型, 如果参数中可能包含中文需要使用six.text_type. 或直接不指定type
参数location: 获取参数的方式,可选的有args(url中获取)、json(json类型的)、form(表单方式提交)
参数required:是否必要,默认非必要提供 required=True(必须)
参数help:针对必要的参数,如果请求时没有提供,则会返回help中相应的信息
'''
parser = reqparse.RequestParser()
#入参parameter,location='json'表示为入参为json格式
parser.add_argument('parameter',location='json')

# 路由类,函数get、post、put、delete等实现http请求方法
# url不带入参 /LISTS
class c_dictList(Resource):
  #类型get,根据列表LISTS,处理,返回一个新的列表r_lists
  def get(self):
    r_lists = []
    for listV in LISTS:
      if listV:
        new_list = {}
        #LISTS列表存的是字典,遍历时为字典listV['parameter'],可获取字典值
        new_list['parameter'] = listV['parameter']
        #LISTS为列表,index可以查出对应下标值
        new_list['url'] = 'url/'+ str(LISTS.index(listV))
        #LISTS列表中添加字典
        r_lists.append(new_list)
    return r_lists
    
  #类型post,在列表LISTS后添加一个值,并返回列表值
  def post(self):
    args = parser.parse_args()
    list_id = len(LISTS)
    #args['parameter'],入参
    LISTS.append({'parameter': args['parameter']}) 
    return LISTS, 201
  
# 路由类,函数get、post、put、delete等实现http请求方法
# url带入参 /LISTS/<list_id>
class c_dict(Resource):
  #根据输入url入参值作为LISTS的下标,返回该值
  def get(self, list_id):
    url_int = int(list_id)
    abort_if_list_doesnt_exist(url_int)
    return LISTS[url_int]
  #根据输入url入参值作为LISTS的下标,修改该值,并返回列表值
  def put(self, list_id):
    url_int = int(list_id)
    args = parser.parse_args()
    #args['parameter'],入参
    parameter = {'parameter': args['parameter']}
    LISTS[url_int] = parameter
    return LISTS, 201
  #根据输入url入参值作为LISTS的下标,删除该值
  def delete(self, list_id):
    url_int = int(list_id)
    abort_if_list_doesnt_exist(url_int)
    del LISTS[url_int]
    return '', 204
#设置资源路由api.add_resource(类名,url路径)
#url,不带入参,如:http://127.0.0.1:8891/LISTS
api.add_resource(c_dictList, '/LISTS')
#url,带入参,<list_id>为变量值,如:http://127.0.0.1:8891/LISTS/1
api.add_resource(c_dict, '/LISTS/<list_id>')

if __name__ == '__main__':
  #不设置ip、端口,默认:http://127.0.0.1:5000/
  #app.run(debug=True)
  #设置ip、端口
  app.run(host="127.0.0.1", port=8891,debug=True)

控制台运行结果:

Serving Flask app "123" (lazy loading) * Environment: production
WARNING: This is a development server. Do not use it in a productiondeployment. Use a production WSGI server instead. * Debug mode: onRestarting with stat * Debugger is active! * Debugger PIN: 279-443-943 * Running on http://127.0.0.1:8891/ (Press CTRL+C toquit)

postman调用结果

url不带参数

get

Python restful框架接口开发实现

post,有请求入参,格式为json,入参值追加到列表后面

Python restful框架接口开发实现

url带参数get,根据url入参值如下图值=1,作为LISTS的下标,获取列表值

Python restful框架接口开发实现

put ,根据url入参值如下图值=1,作为LISTS的下标,修改该列表值为请求入参值,登录改为订单

Python restful框架接口开发实现

put ,根据url入参值如下图值=2,作为LISTS的下标,删除该值,成功返回状态204

Python restful框架接口开发实现

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
Python实现拼接多张图片的方法
Dec 01 Python
Python装饰器入门学习教程(九步学习)
Jan 28 Python
python递归打印某个目录的内容(实例讲解)
Aug 30 Python
详解Django 中是否使用时区的区别
Jun 14 Python
django解决跨域请求的问题
Nov 11 Python
Python 最大概率法进行汉语切分的方法
Dec 14 Python
Flask核心机制之上下文源码剖析
Dec 25 Python
关于pytorch多GPU训练实例与性能对比分析
Aug 19 Python
django实现模板中的字符串文字和自动转义
Mar 31 Python
Keras loss函数剖析
Jul 06 Python
Python 如何展开嵌套的序列
Aug 01 Python
详解如何在pyqt中通过OpenCV实现对窗口的透视变换
Sep 20 Python
Jupyter notebook 启动闪退问题的解决
Apr 13 #Python
windows上彻底删除jupyter notebook的实现
Apr 13 #Python
Python json转字典字符方法实例解析
Apr 13 #Python
Jupyter notebook设置背景主题,字体大小及自动补全代码的操作
Apr 13 #Python
Python unittest框架操作实例解析
Apr 13 #Python
windows python3安装Jupyter Notebooks教程
Apr 13 #Python
Python MOCK SERVER moco模拟接口测试过程解析
Apr 13 #Python
You might like
php miniBB中文乱码问题解决方法
2008/11/25 PHP
php 连接mysql连接被重置的解决方法
2011/02/15 PHP
php解析html类库simple_html_dom(详细介绍)
2013/07/05 PHP
百度工程师讲PHP函数的实现原理及性能分析(三)
2015/05/13 PHP
PHP使用数组实现矩阵数学运算的方法示例
2017/05/29 PHP
php实现文章评论系统
2019/02/18 PHP
PHP中用Trait封装单例模式的实现
2019/12/18 PHP
javascript 模拟JQuery的Ready方法实现并出现的问题
2009/12/06 Javascript
在HTML代码中使用JavaScript代码的例子
2014/10/16 Javascript
JS数组操作(数组增加、删除、翻转、转字符串、取索引、截取(切片)slice、剪接splice、数组合并)
2016/05/20 Javascript
jQuery操作iframe中js函数的方法小结
2016/07/06 Javascript
JS常用倒计时代码实例总结
2017/02/07 Javascript
深入理解Angularjs 脏值检测
2018/10/12 Javascript
vue+Element实现搜索关键字高亮功能
2019/05/28 Javascript
node运行js获得输出的三种方式示例详解
2020/07/02 Javascript
vue单应用在ios系统中实现微信分享功能操作
2020/09/07 Javascript
跟老齐学Python之集合(set)
2014/09/24 Python
理解Python中的With语句
2015/02/02 Python
用Python编写一个简单的俄罗斯方块游戏的教程
2015/04/03 Python
详解Python中的__new__()方法的使用
2015/04/09 Python
使用Python将图片转正方形的两种方法实例代码详解
2020/04/29 Python
Python 防止死锁的方法
2020/07/29 Python
使用Python绘制台风轨迹图的示例代码
2020/09/21 Python
通过python-pptx模块操作ppt文件的方法
2020/12/26 Python
韩国女装NO.1网店:STYLENANDA
2016/09/16 全球购物
美国职棒大联盟官方网上商店:MLBShop.com
2017/11/12 全球购物
三星英国官网:Samsung英国
2018/09/25 全球购物
迪卡侬印尼体育用品商店:Decathlon印尼
2020/03/11 全球购物
新东网科技Java笔试题
2012/07/13 面试题
求职自荐信怎么写
2014/03/06 职场文书
公路绿化方案
2014/05/12 职场文书
敬老院院长事迹材料
2014/05/21 职场文书
初三英语教学反思
2016/02/15 职场文书
幼儿园教学反思范文
2016/03/02 职场文书
导游词之河北邯郸
2019/09/12 职场文书
Win11如何默认打开软件界面最大化?Win11默认打开软件界面最大化的方法
2022/07/15 数码科技