FastAPI+Vue3零基础开发ERP系统项目实战课 20240831上课笔记 路径参数

2024-09-01 10:52
文章标签 javascript 基础 实战 参数 系统 路径 项目 开发 笔记 vue vue3 frontend erp fastapi 上课 20240831

本文主要是介绍FastAPI+Vue3零基础开发ERP系统项目实战课 20240831上课笔记 路径参数，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

遗留的问题

  • 3、FastAPI
  • 4、MySQL8
  • 5、SQLModel，和FastAPI框架是同一个作者，两者结合比较好用，但是学习成本较高，使用难度稍大
  • 6、Vue3
  • 7、Tailwindcss
  • 8、Ant Design Vue，UI组件库
  • 9、数据同步：有一个API，这个API提供了一些数据，需要在ERP系统中进行展示。
  • 10、登录注册需要吗？需要
  • 11、第三方平台管理：对接哪些接口平台飞书，钉钉，聚水潭等等
  • 12、用户管理
  • 13、Docker
  • 14、Linux
  • 15、Nginx
  • 16、项目部署实战

任务：安装postman

下载地址：https://www.postman.com/downloads/

测试我们的第一个接口

接口代码：

from fastapi import FastAPIapp = FastAPI()@app.get("/")
async def root():return {"message": "Hello World"}if __name__ == '__main__':import uvicornuvicorn.run(app, host='0.0.0.0', port=8888)

使用postman进行测试：
在这里插入图片描述

路径参数

官方文档：https://fastapi.tiangolo.com/zh/tutorial/path-params/

官方描述

在这里插入图片描述

什么是路径参数

路径参数，指的是写在URL网址的路径里面的值，它能够将URL中某个路径的值进行捕获，转换为Python的变量。

比如我们经常要根据ID获取用户信息，可能访问的是：http://127.0.0.1:8888/user/3 ，这里的3，可能表示的就是用户的ID，这个ID是动态变化的，可能是1,2,3...任何ID。我们在程序中想要进行捕获，就是需要使用路径参数。

怎么去定义路径参数

比如 http://127.0.0.1:8888/user/3 这个网址中，我们想要对用户的ID进行捕获，我们就可以定义为 /user/{id}，这里的 {id} 就会被FastAPI自动转换为一个叫 id 的变量名，在路由方法中，就可以使用这个变量获取到路径中的真实值，也就是 3。

什么是路由方法？

比如下面的代码：

@app.get("/")
async def root():return {"message": "Hello World"}

root 就是一个路由方法，专门用来处理 / 这个路由的逻辑，当我们访问 http://127.0.0.1:8888/ 的时候，会自动执行这个方法。这种专门用来处理某个特定路由的方法，就叫做路由方法。

什么是路径？

比如在上面的方法中，@app.get("/")，在这段代码中，括号中的字符串，就表示路径。路径指的是我们域名后面紧跟着的访问地址，比如http://127.0.0.1:8888/ ，http://127.0.0.1:8888叫做域名，在真实的线上环境中，可能会被替换为一个网址，比如http://www.baidu.com。域名后面紧跟着就是/，这个斜杆就是访问的地址，也就是路径。

这里的路径是网址中的路径，无论什么系统都是 /，这点和文件路径不一样。

怎么获取路径变量

比如下面的代码：

@app.get("/items/{item_id}")
async def read_item(item_id):return {"item_id": item_id}

我们在定义完路径参数@app.get("/items/{item_id}")之后，紧跟着，一定要在方法的参数中，写一个完全相同的变量名async def read_item(item_id)，最后，我们在方法体中，就可以把路径参数，当成一个正常的变量名return {"item_id": item_id}去进行使用了。

案例：根据ID获取用户的信息

首先参考代码：

@app.get("/items/{item_id}")
async def read_item(item_id):return {"item_id": item_id}

然后，我们改一下路径和变量名：

@app.get("/user/{id}")
async def read_item(id):return {"id": id}

具体实践：

from fastapi import FastAPIapp = FastAPI()@app.get("/user/{id}")
async def get_user_by_id(id):return {"id": id}if __name__ == '__main__':import uvicornuvicorn.run(app, host='0.0.0.0', port=8888)

测试：
在这里插入图片描述

简单总结

  • 什么是路径参数：写在域名后面的，可以被捕获为变量的特殊路径
  • 怎么定义路径参数：先在路径中使用花括号捕获，然后在方法参数中声明一个完全相同的变量
  • 什么时候使用路径参数：比如想要根据ID获取用户信息的时候，ID可能是任意变化的，这个时候就可以把ID设置成路径参数

声明路径参数的类型

使用 Python 标准类型注解，声明路径操作函数中路径参数的类型。

from fastapi import FastAPIapp = FastAPI()@app.get("/items/{item_id}")
async def read_item(item_id: int):return {"item_id": item_id}

本例把 item_id 的类型声明为 int。

回顾基础数据类型

  • int：整数
  • str：字符串
  • bool：布尔值
  • list：列表
  • dict：字典
  • tuple：元组
  • set：集合
  • float：浮点数

继续根据ID获取用户信息的案例

ID应该是什么类型？

  • int整数类型：这种时候，一般是数据库设置了自增ID
  • str字符串类型：这种时候，ID可能是UUID字符串，可能是其他算法生成的字符串

什么是ID？

  • id（Identity document），是身份证标识号、账号、唯一编码、专属号码、工业设计、国家简称、法律词汇、通用账户、译码器、软件公司等各类专有词汇的缩写。
  • 是一个唯一的表示，全局只能出现一次，不能重复

如何声明路径参数的类型

在方法参数中，read_item(item_id: int) 通过冒号:拼接参数类型，在参数名称后面跟冒号，冒号后面声明这个参数的具体类型即可。

案例：声明ID为int类型

from fastapi import FastAPIapp = FastAPI()@app.get("/user/{id}")
async def get_user_by_id(id: int):return {"id": id}if __name__ == '__main__':import uvicornuvicorn.run(app, host='0.0.0.0', port=8888)

修改之前的结果：
在这里插入图片描述

修改之后的结果：
在这里插入图片描述

修改之前，是有双引号的，表示是字符串类型。修改之后没有双引号了，表示是整数类型。

数据校验

当我们声明了路径参数类型以后，数据就会被自动校验。

比如我们根据ID获取用户信息，id被声明为int类型，此时如果你传个不能转换为int类型的字符串过去，就会报错。

比如：
在这里插入图片描述

查看文档

FastAPI会自动给我们的每个接口生成一个接口文档。

访问 http://127.0.0.1:8000/docs，查看自动生成的 API 文档：

在这里插入图片描述

这个接口文档是可以执行的：
在这里插入图片描述

文件路径参数

示例代码如下：

from fastapi import FastAPIapp = FastAPI()@app.get("/files/{file_path:path}")
async def read_file(file_path: str):return {"file_path": file_path}

注意，声明文件路径作为路径参数，需要遵循特殊的语法：{file_path:path}，这个时候，会把 /files/后面的所有内容都捕获，然后转换为路径参数变量。比如我们传递的是/files/a/b/c.txt，这个时候file_path的值就是a/b/c.txt。

实践：

from fastapi import FastAPIapp = FastAPI()@app.get("/user/{avatar:path}")
async def get_user_avatar(avatar: str):return {"avatar": avatar}if __name__ == '__main__':import uvicornuvicorn.run(app, host='0.0.0.0', port=8888)

使用postman测试：
在这里插入图片描述

总结

  • 路径参数
  • 怎么捕获文件路径？{avatar:path}
  • 怎么定义路径参数？/user/{id}
  • 什么时候使用路径参数？当我们需要通过路径传递变量值的时候，比如用户ID，比如博客ID

URL 示例

比如CSDN的一个网址：https://blog.csdn.net/qq_37703224/article/details/141724195?spm=1001.2014.3001.5501

  • 域名：https://blog.csdn.net
  • 路径参数：/qq_37703224/article/details/141724195
  • 查询参数：?spm=1001.2014.3001.5501

路径参数：/qq_37703224/article/details/141724195

  • 第一个路径很明显就是一个路径参数，用来确定是哪个用户，可以认为是用户名或者用户ID
  • 第二个路径表示的类型，article表示文章，这个可能是路径参数，也可能不是
  • 第三个路径表示的是详情，detail，这个一般都不是路径参数，也就是不是一个变量
  • 第四个路径表示的是文章的ID，这个很明显也是一个路径参数，也就是一个变量

这篇关于FastAPI+Vue3零基础开发ERP系统项目实战课 20240831上课笔记 路径参数的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1126737。

相关文章

一文教你如何将maven项目转成web项目

一文教你如何将maven项目转成web项目

《一文教你如何将maven项目转成web项目》在软件开发过程中,有时我们需要将一个普通的Maven项目转换为Web项目,以便能够部署到Web容器中运行,本文将详细介绍如何通过简单的步骤完成这一转换过程... 目录准备工作步骤一：修改​​pom.XML​​1.1 添加​​packaging​​标签1.2 添加
阅读更多...
tomcat多实例部署的项目实践

tomcat多实例部署的项目实践

《tomcat多实例部署的项目实践》Tomcat多实例是指在一台设备上运行多个Tomcat服务,这些Tomcat相互独立,本文主要介绍了tomcat多实例部署的项目实践,具有一定的参考价值,感兴趣的可... 目录1.创建项目目录，测试文China编程件2js.创建实例的安装目录3.准备实例的配置文件4.编辑实例的
阅读更多...
C#基础之委托详解(Delegate)

C#基础之委托详解(Delegate)

《C#基础之委托详解(Delegate)》：本文主要介绍C#基础之委托(Delegate),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1. 委托定义2. 委托实例化3. 多播委托（Multicast Delegates）4. 委托的用途事件处理回调函数LINQ
阅读更多...
利用Python开发Markdown表格结构转换为Excel工具

利用Python开发Markdown表格结构转换为Excel工具

《利用Python开发Markdown表格结构转换为Excel工具》在数据管理和文档编写过程中,我们经常使用Markdown来记录表格数据,但它没有Excel使用方便,所以本文将使用Python编写一... 目录1.完整代码2. 项目概述3. 代码解析3.1 依赖库3.2 GUI 设计3.3 解析 Mark
阅读更多...
Vue中组件之间传值的六种方式（完整版）

Vue中组件之间传值的六种方式（完整版）

《Vue中组件之间传值的六种方式（完整版）》组件是vue.js最强大的功能之一,而组件实例的作用域是相互独立的,这就意味着不同组件之间的数据无法相互引用,针对不同的使用场景,如何选择行之有效的通信方式... 目录前言方法一、props/$emit1.父组件向子组件传值2.子组件向父组件传值（通过事件形式）方
阅读更多...
css中的 vertical-align与line-height作用详解

css中的 vertical-align与line-height作用详解

《css中的vertical-align与line-height作用详解》：本文主要介绍了CSS中的`vertical-align`和`line-height`属性，包括它们的作用、适用元素、属性值、常见使用场景、常见问题及解决方案，详细内容请阅读本文，希望能对你有所帮助... 目录vertical-ali
阅读更多...
springboot集成Deepseek4j的项目实践

springboot集成Deepseek4j的项目实践

《springboot集成Deepseek4j的项目实践》本文主要介绍了springboot集成Deepseek4j的项目实践,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价... 目录Deepseek4j快速开始Maven 依js赖基础配置基础使用示例1. 流式返回示例2. 进阶
阅读更多...
利用Go语言开发文件操作工具轻松处理所有文件

利用Go语言开发文件操作工具轻松处理所有文件

《利用Go语言开发文件操作工具轻松处理所有文件》在后端开发中,文件操作是一个非常常见但又容易出错的场景,本文小编要向大家介绍一个强大的Go语言文件操作工具库,它能帮你轻松处理各种文件操作场景... 目录为什么需要这个工具？核心功能详解1. 文件/目录存javascript在性检查2. 批量创建目录3. 文件
阅读更多...
Linux系统之主机网络配置方式

Linux系统之主机网络配置方式

《Linux系统之主机网络配置方式》：本文主要介绍Linux系统之主机网络配置方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、查看主机的网络参数1、查看主机名2、查看IP地址3、查看网关4、查看DNS二、配置网卡1、修改网卡配置文件2、nmcli工具【通用
阅读更多...
Linux系统之dns域名解析全过程

Linux系统之dns域名解析全过程

《Linux系统之dns域名解析全过程》：本文主要介绍Linux系统之dns域名解析全过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、dns域名解析介绍1、DNS核心概念1.1 区域 zone1.2 记录 record二、DNS服务的配置1、正向解析的配置
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2