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。

相关文章

SpringBoot项目中Maven剔除无用Jar引用的最佳实践

SpringBoot项目中Maven剔除无用Jar引用的最佳实践

《SpringBoot项目中Maven剔除无用Jar引用的最佳实践》在SpringBoot项目开发中,Maven是最常用的构建工具之一,通过Maven,我们可以轻松地管理项目所需的依赖,而,... 目录1、引言2、Maven 依赖管理的基础概念2.1 什么是 Maven 依赖2.2 Maven 的依赖传递机
阅读更多...
C#实现系统信息监控与获取功能

C#实现系统信息监控与获取功能

《C#实现系统信息监控与获取功能》在C#开发的众多应用场景中,获取系统信息以及监控用户操作有着广泛的用途,比如在系统性能优化工具中,需要实时读取CPU、GPU资源信息,本文将详细介绍如何使用C#来实现... 目录前言一、C# 监控键盘1. 原理与实现思路2. 代码实现二、读取 CPU、GPU 资源信息1.
阅读更多...
Vue项目中Element UI组件未注册的问题原因及解决方法

Vue项目中Element UI组件未注册的问题原因及解决方法

《Vue项目中ElementUI组件未注册的问题原因及解决方法》在Vue项目中使用ElementUI组件库时,开发者可能会遇到一些常见问题,例如组件未正确注册导致的警告或错误,本文将详细探讨这些问题... 目录引言一、问题背景1.1 错误信息分析1.2 问题原因二、解决方法2.1 全局引入 Element
阅读更多...
详解如何在React中执行条件渲染

详解如何在React中执行条件渲染

《详解如何在React中执行条件渲染》在现代Web开发中,React作为一种流行的JavaScript库,为开发者提供了一种高效构建用户界面的方式,条件渲染是React中的一个关键概念,本文将深入探讨... 目录引言什么是条件渲染？基础示例使用逻辑与运算符（&&）使用条件语句列表中的条件渲染总结引言在现代
阅读更多...
Python调用另一个py文件并传递参数常见的方法及其应用场景

Python调用另一个py文件并传递参数常见的方法及其应用场景

《Python调用另一个py文件并传递参数常见的方法及其应用场景》：本文主要介绍在Python中调用另一个py文件并传递参数的几种常见方法,包括使用import语句、exec函数、subproce... 目录前言1. 使用import语句1.1 基本用法1.2 导入特定函数1.3 处理文件路径2. 使用ex
阅读更多...
详解Vue如何使用xlsx库导出Excel文件

详解Vue如何使用xlsx库导出Excel文件

《详解Vue如何使用xlsx库导出Excel文件》第三方库xlsx提供了强大的功能来处理Excel文件,它可以简化导出Excel文件这个过程,本文将为大家详细介绍一下它的具体使用,需要的小伙伴可以了解... 目录1. 安装依赖2. 创建vue组件3. 解释代码在Vue.js项目中导出Excel文件，使用第三
阅读更多...
Java实现Excel与HTML互转

Java实现Excel与HTML互转

《Java实现Excel与HTML互转》Excel是一种电子表格格式,而HTM则是一种用于创建网页的标记语言,虽然两者在用途上存在差异,但有时我们需要将数据从一种格式转换为另一种格式,下面我们就来看看... Excel是一种电子表格格式，广泛用于数据处理和分析，而HTM则是一种用于创建网页的标记语言。虽然两
阅读更多...
在C#中获取端口号与系统信息的高效实践

在C#中获取端口号与系统信息的高效实践

《在C#中获取端口号与系统信息的高效实践》在现代软件开发中,尤其是系统管理、运维、监控和性能优化等场景中,了解计算机硬件和网络的状态至关重要,C#作为一种广泛应用的编程语言,提供了丰富的API来帮助开... 目录引言1. 获取端口号信息1.1 获取活动的 TCP 和 UDP 连接说明：应用场景：2. 获取硬
阅读更多...
Golang操作DuckDB实战案例分享

Golang操作DuckDB实战案例分享

《Golang操作DuckDB实战案例分享》DuckDB是一个嵌入式SQL数据库引擎,它与众所周知的SQLite非常相似,但它是为olap风格的工作负载设计的,DuckDB支持各种数据类型和SQL特性... 目录DuckDB的主要优点环境准备初始化表和数据查询单行或多行错误处理和事务完整代码最后总结Duck
阅读更多...
JAVA系统中Spring Boot应用程序的配置文件application.yml使用详解

JAVA系统中Spring Boot应用程序的配置文件application.yml使用详解

《JAVA系统中SpringBoot应用程序的配置文件application.yml使用详解》：本文主要介绍JAVA系统中SpringBoot应用程序的配置文件application.yml的... 目录文件路径文件内容解释1. Server 配置2. Spring 配置3. Logging 配置4. Ma
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2