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使用在线API查询IP对应的地理位置信息实例
Jun 01 Python
python 简单的绘图工具turtle使用详解
Jun 21 Python
利用标准库fractions模块让Python支持分数类型的方法详解
Aug 11 Python
利用python操作SQLite数据库及文件操作详解
Sep 22 Python
python实现傅里叶级数展开的实现
Jul 21 Python
Python处理时间日期坐标轴过程详解
Jun 25 Python
Python3实现将一维数组按标准长度分隔为二维数组
Nov 29 Python
python实现简单飞行棋
Feb 06 Python
django model的update时auto_now不被更新的原因及解决方式
Apr 01 Python
tensorflow实现从.ckpt文件中读取任意变量
May 26 Python
python rolling regression. 使用 Python 实现滚动回归操作
Jun 08 Python
用Python提取PDF表格的方法
Apr 11 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 addslashes()与addclashes()函数的区别和比较
2013/06/24 PHP
php/js获取客户端mac地址的实现代码
2013/07/08 PHP
PHP实现ftp上传文件示例
2014/08/21 PHP
ThinkPHP中使用ajax接收json数据的方法
2014/12/18 PHP
PHP+MySQL插入操作实例
2015/01/21 PHP
PHP中把数据库查询结果输出为json格式简单实例
2015/04/09 PHP
php基于curl扩展制作跨平台的restfule 接口
2015/05/11 PHP
php 基础函数
2017/02/10 PHP
Laravel5.5 动态切换多语言的操作方式
2019/10/25 PHP
使用TextRange获取输入框中光标的位置的代码
2007/03/08 Javascript
Jquery+ajax请求data显示在GridView上(asp.net)
2010/08/27 Javascript
干货分享:让你分分钟学会javascript闭包
2015/12/25 Javascript
简单总结JavaScript中的String字符串类型
2016/05/26 Javascript
超实用的javascript时间处理总结
2016/08/16 Javascript
jQuery图片加载显示loading效果
2016/11/04 Javascript
BootStrap入门学习第一篇
2017/08/28 Javascript
优雅的elementUI table单元格可编辑实现方法详解
2018/12/23 Javascript
JavaScript中的this/call/apply/bind的使用及区别
2020/03/06 Javascript
wxpython 学习笔记 第一天
2009/02/09 Python
python实现多线程的方式及多条命令并发执行
2016/06/07 Python
判断python对象是否可调用的三种方式及其区别详解
2019/01/31 Python
python GUI库图形界面开发之PyQt5美化窗体与控件(异形窗体)实例
2020/02/25 Python
python爬虫智能翻页批量下载文件的实例详解
2021/02/02 Python
以实惠的价格轻松租车,免费取消:Easyrentcars
2019/07/16 全球购物
英国最受信任的在线眼镜商之一:Fashion Eyewear
2019/10/31 全球购物
学习委员自我鉴定
2014/01/13 职场文书
特色蛋糕店创业计划书
2014/01/28 职场文书
离职保密承诺书
2014/05/28 职场文书
尊师重教演讲稿
2014/09/04 职场文书
科学发展观演讲稿
2014/09/11 职场文书
2014年采购部工作总结
2014/11/20 职场文书
单位接收证明格式
2015/06/18 职场文书
Nginx源码编译安装过程记录
2021/11/17 Servers
golang为什么要统一错误处理
2022/04/03 Golang
SQL Server的存储过程与触发器以及系统函数和自定义函数
2022/04/10 SQL Server
详解Mysql数据库平滑扩容解决高并发和大数据量问题
2022/05/25 MySQL