Python进行Restful API开发实例详解

 更新时间:2022年03月30日 10:09:16   作者:Bulut0907  
这篇文章主要介绍了Python进行Restful API开发实例,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

1. Flask-RESTful

1.安装pip依赖

[root@bigdata001 ~]#
[root@bigdata001 ~]# pip3 install flask
[root@bigdata001 ~]#
[root@bigdata001 ~]# pip3 install flask_restful
[root@bigdata001 ~]#

2.运行程序如下:

#!/usr/bin/python3
from flask import Flask
from flask_restful import Resource, Api, reqparse
host = '0.0.0.0'
port = 5600
app = Flask(__name__)
api = Api(app)
class HelloWorld(Resource):
    def __init__(self):
        self.parser = reqparse.RequestParser()
        self.parser.add_argument("key1", type = str)
        self.parser.add_argument("key2", type = str)
    def get(self):
        data = self.parser.parse_args()
        value1 = data.get("key1")
        value2 = data.get("key2")
        return {'hello':'world', value1:value2}
api.add_resource(HelloWorld, '/query')
if __name__ == '__main__':
    app.run(host = host, port = port, debug = True)

3.请求URL: http://192.168.23.21:5600/query?key1=fruit&key2=apple

4.查看Web页面返回结果如下:

{
    "hello": "world",
    "fruit": "apple"
}

2. fastapi + nacos服务注册

1.安装pip依赖

[root@bigdata001 ~]#
[root@bigdata001 ~]# pip install fastapi
[root@bigdata001 ~]#
[root@bigdata001 ~]# pip install uvicorn
[root@bigdata001 ~]#
[root@bigdata001 ~]# pip3 install nacos-sdk-python
[root@bigdata001 ~]#

2.router模块程序如下:

from typing import Optional
from fastapi import APIRouter, Query, Path
fastapi_router=APIRouter()
@fastapi_router.get(path="/")
async def read_root():
    return {"Hello": "World"}
@fastapi_router.get(path = "/items/{my_item_id}",
                    summary='路径测试',
                    description='路径测试',
                    tags=['测试模块'],
                    response_description='{"my_item_id": my_item_id, "q": q}')
async def read_item(my_item_id: int=Path(None, description="我的item id"),
                    q: Optional[str] = Query(None, description="查询参数")):
    return {"my_item_id": my_item_id, "q": q}

3.app模块程序如下:

import nacos
from fastapi import FastAPI
import fastapi_router
def register_server_to_nacos():
    nacos_server_addresses = '192.168.8.246:8848'
    nacos_namespace = 'public'
    nacos_user = 'xxxxxx'
    nacos_password = '123456'
    nacos_cluster_name = 'DEFAULT'
    nacos_group_name = 'DEFAULT_GROUP'
    nacos_project_service_name = 'data-quality-system'
    nacos_project_service_ip = '192.168.8.111'
    nacos_project_service_port = 6060
    
    client = nacos.NacosClient(nacos_server_addresses,
                               namespace=nacos_namespace,
                               username=nacos_user,
                               password=nacos_password)
    client.add_naming_instance(nacos_project_service_name,
                               nacos_project_service_ip,
                               nacos_project_service_port,
                               cluster_name = nacos_cluster_name,
                               weight = 1,
                               metadata = None,
                               enable = True,
                               healthy = True,
                               ephemeral = False,
                               group_name = nacos_group_name)
    client.send_heartbeat(nacos_project_service_name,
                          nacos_project_service_ip,
                          nacos_project_service_port,
                          cluster_name=nacos_cluster_name,
                          weight=1,
                          metadata=None,
                          ephemeral=False,
                          group_name=nacos_group_name)
app = FastAPI(title='my_fastapi_docs',description='my_fastapi_docs')
app.include_router(router=fastapi_router.fastapi_router)
if __name__ == '__main__':
	register_server_to_nacos()
	
    import uvicorn
    uvicorn.run(app=app, host="0.0.0.0",port=8080, workers=1)

4.请求URL: http://192.168.43.50:8080/items/6?q=fastapi

5.查看Web页面返回结果如下:

{"my_item_id":6,"q":"fastapi"}

查看fastapi docs路径:http://192.168.43.50:8080/docs,结果如下:

fastapi doc

tag部分

response

查看nacos页面如下:

nacos服务

服务详情

2.1 post

post代码片段如下:

from pydantic import BaseModel

class Item(BaseModel):
    name: str
    description: Optional[str] = None
    price: float
    tax: Optional[float] = None

@fastapi_router.post("/items/")
async def create_item(item: Item):
    print(item.dict())
    return item

执行requestTest.py

import requests
url = "http://192.168.88.177:6060/items"
data = {
    "name" : "bigdataboy",
    "price": 100,
}
response = requests.post(url=url,json=data)
print(response.json())

post代码片段和requestTest.py的执行结果都是

{'name': 'bigdataboy', 'description': None, 'price': 100.0, 'tax': None}

2.2 get请求接收list参数

get代码片段如下:

from typing import List

@fastapi_router.get(path = "/items/get_list")
async def get_list(id: int = Query(None),
                    names: List[str] = Query(None)
                   ):
    return {"id":id, "names":names}

访问http://192.168.88.177:8080/items/get_list?id=3&names=test1&names=test2,得到的结果如下:

get list的结果

2.3 请求URL进行文件下载

get代码片段如下:

from starlette.responses import FileResponse
@fastapi_router.get(path = "/items/downloadFile")
async def downloadFile():
    return FileResponse('C:\\Users\\dell\\Desktop\\test.txt', filename='test.txt')

访问http://192.168.88.177:8080/items/downloadFile,得到的结果如下:

下载文件

2.4 获取Request Headers的Authorization,并使用JWT解析

使用浏览器F12查看的Authorization如下:

Authorization

以上URL的请求是公司的前端向后端请求数据,只是记录下来,并自己并没有做模拟测试

jwt的安装

from starlette.responses import FileResponse

@fastapi_router.get(path = "/items/downloadFile")
async def downloadFile():
    return FileResponse('C:\\Users\\dell\\Desktop\\test.txt', filename='test.txt')

demo如下:

from fastapi import Request
import jwt
@fastapi_router.get(path = "/items/get_authorization")
async def get_authorization(request:Request,
                       name: str):
                       
    authorization = request.headers.get('authorization')
    token = authorization[7:]
    token_dict = jwt.decode(token, options={"verify_signature": False})
	return token_dict

访问http://192.168.88.177:8080/items/get_authorization?name=zhang_san,得到的结果如下:

{
'key1': value1, 
'key2': 'value2'
}

到此这篇关于Python进行Restful API开发实例的文章就介绍到这了,更多相关Python Restful API开发内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • python opencv人脸检测提取及保存方法

    python opencv人脸检测提取及保存方法

    今天小编就为大家分享一篇python opencv人脸检测提取及保存方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-08-08
  • Python Tkinter实现简易计算器功能

    Python Tkinter实现简易计算器功能

    这篇文章主要为大家详细介绍了Python Tkinter实现简易计算器功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-01-01
  • 基于python实现的百度音乐下载器python pyqt改进版(附代码)

    基于python实现的百度音乐下载器python pyqt改进版(附代码)

    这篇文章主要介绍了基于python实现的百度音乐下载器python pyqt改进版(附代码),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-08-08
  • Django 项目重命名的实现步骤解析

    Django 项目重命名的实现步骤解析

    这篇文章主要介绍了Django 项目重命名的实现步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-08-08
  • python url 参数修改方法

    python url 参数修改方法

    今天小编就为大家分享一篇python url 参数修改方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-12-12
  • django中间件及自定义中间件的实现方法

    django中间件及自定义中间件的实现方法

    中间件就是在目标和结果之间进行的额外处理过程,在Django中就是request和response之间进行的处理,相对来说实现起来比较简单,这篇文章主要介绍了django中间件以及自定义中间件 ,需要的朋友可以参考下
    2023-06-06
  • Python实现捕获异常发生的文件和具体行数

    Python实现捕获异常发生的文件和具体行数

    这篇文章主要介绍了Python实现捕获异常发生的文件和具体行数。具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-04-04
  • Python 操作 Excel 之 openpyxl 模块

    Python 操作 Excel 之 openpyxl 模块

    这篇文章主要介绍了Python 操作 Excel 之 openpyxl 模块,文章基于python的相关资料展开对 openpyxl 模块的详细介绍,具有一定的参考价值,需要的小伙伴可以参考一下
    2022-05-05
  • 关于python中密码加盐的学习体会小结

    关于python中密码加盐的学习体会小结

    这篇文章主要介绍了关于python中密码加盐的学习体会小结,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-07-07
  • 对python mayavi三维绘图的实现详解

    对python mayavi三维绘图的实现详解

    今天小编就为大家分享一篇对python mayavi三维绘图的实现详解,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-01-01

最新评论