python---FlaskAPI基本用法

flask基础应用

ulr详解结构

URL是Uniform Resource Locator的简写，统一资源定位符。

一个URL由以下几部分组成：

scheme://host:port/path/?query-string=xxx#anchor

• scheme：代表的是访问的协议，一般为http或者https以及ftp等。
• host：主机名，域名，比如www.baidu.com。
• port：端口号。当你访问一个网站的时候，浏览器默认使用80端口。
• path：查找路径。比如：www.jianshu.com/trending/now，后面的trending/now就是path。
• query-string：查询字符串，比如：www.baidu.com/s?wd=python，后面的wd=python就是查询字符串。
• anchor：锚点，后台一般不用管，前端用来做页面定位的

web服务器和应用服务器以及web应用框架：

web服务器：

负责处理http请求，响应静态文件，常见的有Apache，Nginx以及微软的IIS.

应用服务器：

负责处理逻辑的服务器。比如php、python的代码，是不能直接通过nginx这种web服务器来处理的，只能通过应用服务器来处理，常见的应用服务器有uwsgi、tomcat等。

web应用框架：

一般使用某种语言，封装了常用的web功能的框架就是web应用框架，flask、Django以及Java中的SSH(Structs2+Spring3+Hibernate3)框架都是web应用框架。

flask的基础结构

创建好Flask项目工程后 会有两个文件夹 以及一个py文件

​ static:放置所有的静态文件

​ templates:放置模板文件

​ 默认的py文件是主app文件

主app文件的代码结构

​

from flask import Flask #从flask中导入flask类
#用flask类 创建一个对象 传递name参数
#name参数: 规定模板和静态文件的查找路径
 #一些flask插件如果报错了 那么Flask可以通过这个参数找到报错具体位置
app = Flask(__name__)

#这个装饰器就是将('/') 作为url请求路径拼接到域名后
#把hello_woprd的返回值 映射到这个路径下
#换句话说 每次访问'/' 这个路径时 就会执行这个hello_word函数
@app.route('/')
def hello_world():
    return 'Hello World!'

#主方法
if __name__ == '__main__':
    #app.run()启动服务器
	 #run的参数(self, host=None, port=None, debug=None, load_dotenv=True, **options)
     #host: 默认是本机ip 如果需要在局域网内其他设备访问项目 host指定成:0.0.0.0 即可
     #port:端口号默认是5000
     #debug:默认是False False代表debug未开启 True开启debug
	 app.run(debug=True)

​

第一个Flask项目

现在写一个业务是文章列表的后端程序

请求路径是’/list/’ 返回的数据是一个数组 然后启动服务 打开浏览器 输入127.0.0.1:5000/list/

from flask import Flask

app = Flask(__name__)


@app.route('/')
def hello_world():
    return 'Hello World!'
    
    
@app.route('/list/')
def book_list():
    return "['status':0,'msg':'获取成功','data':{'name':'Flask后端开发','price':58}]"


if __name__ == '__main__':
    app.run(debug=True)

请求方法GET、POST

1、get请求只会在服务器上获取数据 不会更改服务的状态，请求参数是拼接到URL地址栏后面的

2、post请求可以获取资源 也可以更改数据 、上传数据 请求参数是放在formdata表单中的

在Flask中 默认是GET请求 那么怎么指定成POST请求

在app.route内可以传入参数methods指定成POST 如下:

@app.route('/list/',methods= ['POST'])
def book_list():
    return "['status':0,'msg':'获取成功','data':{'name':'Flask后端开发','price':58}]"

当然如果 需要GET、POST请求都可以请求的话 可以把GET、POST全部传入method数组里

@app.route('/list/',methods= ['GET','POST'])
def book_list():
    return "['status':0,'msg':'获取成功','data':{'name':'Flask后端开发','price':58}]"

URL与视图函数的映射:

在url中传递参数

案例

比如在百度中输入搜索关键字flask 那么在url中就会出现参数wd=falsk 这说明 在输入框中传的值 其实是wd的实际参数

或者说查看一篇文章或一个用户的主页时 在url后面 也会携带 该文章的id参数及该用户的id参数

实现参数传递

第一种传递参数方式

以查看文章详情为例 请求路径为article 请求的参数需要以<> 的形式 包裹起来

app.route中使用了什么参数 那么就要给函数传递同样的参数

@app.route('/article/<article_id>/')
def article_datail(article_id):
    return "本次访问的文章是{}".format(article_id)

启动服务 打开浏览器 试一下 127.0.0.1:5000/article/1/ 这个

可以看到在url中转递的文章参数的id是1那么返回的数据也是相同的

第二种传递参数的方式

查询字符串的方式

实现如同百度搜索关键字时的参数传递的操作

如在首页输入python :https://www.baidu.com/s?wd=python

可以看到python的参数 是通过 ?wd=python传进去的 那如果通过Flask如何做出效果

from flask import Flask,request
@app.route('/d/')
def d():
    wd = request.args.get('wd')
    return "通过查询字符串的方法传递的参数是{}".format(wd)

然后通过:http://127.0.0.1:5000/d/?wd=python 访问

指定参数的数据类型

• string: 默认的数据类型，接受没有任何斜杠 / 的字符串。
  int: 整形
  float: 浮点型。
  path:和 string 类似，但是可以传递斜杠 /
  uuid: uuid 类型的字符串。
  any：可以指定多种路径

数据类型限制成int类型

在<>内加上int:article_id 即可 然后启动服务 如果输入非int的数据 就会404

@app.route('/article/<int:article_id>/')#
def article_datail(article_id):
    return "本次访问的文章是{}".format(article_id)

限制成float数据类型

现在只能输入float类型的参数了

@app.route('/article/<float:article_id>/')
def article_datail(article_id):
    return "本次访问的文章是{}".format(article_id)

path数据类型

path类型 可以传递/ 也就意味着 可以传递多个路径

用string类型的时候路径:127.0.0.1:5000/artucle/1/

path数据类型可以使用: 127.0.0.1:5000/artucle/1/11/

path就可传递多路径

@app.route('/article/<path:article_id>/')
def article_datail(article_id):
    return "本次访问的文章是{}".format(article_id)

uuid数据类型

uuid数据类型会生成一段无规律唯一的字符串 一般用来加密显示

比如:显示用户的id的时候 一般不会被人看到用户从而猜出 用户总数 可与加密显示

uuid的参数传递需要遵守一定的格式 用uuid.uuid4()获取格式 然后填入浏览器中

import uuid
print("-"*30)
print(uuid.uuid4())#获取uuid的格式
print("-"*30)
@app.route('/u/<uuid:user_id>/')
def user_datail(user_id):
    return "访问用户个人界面:{}".format(user_id)

any数据类型

指定多个路径 下方代码用any()指定了两个url路径 一个是article 另一个blog

并 且，一定要传 url_path 参数，当然这个 url_path 的名称可以随便 冒号后面的url_path会把前面的请求路径传给这个变量

@app.route('/<any(article,blog):url_path>/<id>/')
def item(url_path,id):
    if url_path == 'blog':
        return "当前的请求博客{}的第{}文章".format(url_path,id)
    elif url_path == "article":
        return "当前请求是用户{},用户id为:{}".format(url_path,id)

判断数据类型isinstance

@app.route('/my_info/',method=['GET','POST'])
def my_info():
    id = request.args.post('id')
    if not id:
        return "没有id"
    elif not isinstance(id,int):
        return "id必须为整数"
    else:
        return "该用户id为{}".format(id)

url_for使用详解

先看一下url_for需要传的参数def url_for(endpoint, **values):

第一个endpoint参数需要传递字符串的视图函数 这个也是必传的

url_for的用途

简单的来说 就是 在url_for里面传递了一个视图函数后 它会将这个视图函数对应的app.route()里的路径返回

@app.route('/')
def hello_world():
    #传入index_info视图函数后 访问'/'路径时 
    #print会打印index_inindexfo函数的url路径'/index/'
    print(url_for('index_info'))
    return "hello"

@app.route('/index/')
def index_info():
    return "{'name':'zhiliao','a'}"
>>>/index/

url_for反转时的参数传递

如果上面index_info视图 有参数 比如page参数 那么如何在反转时传递

可以在url_for()内使用关键字参数

@app.route('/')
def hello_world():
    # print()
    url = url_for('index_info',page = 1)
    return url#返回 /index/1/

@app.route('/index/<page>/')
def index_info(page):
    return f"{'name':'zhiliao','page':page}"

如果在url_for中传递了一个index_info函数 没有定义的参数 就会把参数拼接成查询字符串的方式

@app.route('/')
def hello_world():
    # print()
    url = url_for('index_info',page = 1)
    return url#返回/index/?page=1

@app.route('/index/')
def index_info():
    return {"status":0,"name":"zhiliao","msg":"获取成功","page":1}

页面跳转与重定向

重定向分为永久性重定向和暂时性重定向 就是浏览器从一个页面跳转到另一个页面 比如用户访问一个需要身份登录的页面由于没有登录所以自动跳转到登录页面 ，登录完成后再跳转回来

永久性重定向: HTTPcode:301 比如 访问一个域名已经更换的网站 如果该网站实现了永久性重定向

就会直接跳转到新的网站

暂时性重定向: HTTPcode:302 用户没有登录的情况下 访问发帖请求 跳转到登录页面 登录成功后 再跳转回发帖页面

在 flask 中，重定向是通过 flask.redirect(location,code=302) 这个函数来实现
的， location 表示需要重定向到的 URL ，应该配合之前讲的 url_for() 函数来使用， code 表 示采用哪个重定向，默认是 302 也即 暂时性重定向 ，可以修改成 301 来实现永久性重定向

redirect 默认是302暂时重定向

from flask import Flask,request,url_for,redirect
from flask_restful import Resource,Api,reqparse
app = Flask(__name__)
is_login_dictl = {
    "is_login":True
}

@app.route('/login/')
def login():
    return "登录页面"


@app.route('/my_info/')
def my_info():
    if is_login_dictl['is_login'] == True:
        return "个人页面"
    else:
        return redirect(url_for('login'))
    

if __name__ == '__main__':
    app.run(debug=True)

业务实战练习

场景设计

模拟一个书籍管理项目 该项目的功能有: 查询书籍信息 和修改增加书籍

代码实战

先完成查询的功能

books字典是初始化的一下书籍信息的

查询接口可以以id参数进行指定查询 如果不传参数或者参数不存在就返回 全部 数据

# -*- coding:utf-8 -*-
from flask import Flask,request,url_for,jsonify,redirect,make_response,render_template
from flask_restful import Resource,Api,reqparse
import json
app = Flask(__name__)

@app.errorhandler(404)
def not_find(error):
    return make_response("<img src=../static/u=2453368590,3077318655&fm=26&gp=0.jpg>",404)


#books是书籍的初始化数据
books = {
    "1":{"id":1,"name":"wuya","bname":"python进阶","price":25},
    "2":{"id":2,"name":"wuya","bname":"python接口测试实战","price":45}
}


@app.route('/v1/list/',methods=['GET'])
def book_list():
    #获取书籍的数据并返回
    par = reqparse.RequestParser()
    par.add_argument('id')
    id = par.parse_args()
    """以id查询书籍信息
    	如果不传id 或者id不存在 就返回全部书籍信息
    """
    try:
        if id:
            return books[id['id']]
    except Exception as e:
        return jsonify(books)


if __name__ == "__main__":
    app.run(debug=True)

​