【Python系列】FastAPI 中的路径参数和非路径参数解析问题

💝💝💝欢迎来到我的博客，很高兴能够在这里和您见面！希望您在这里可以感受到一份轻松愉快的氛围，不仅可以获得有趣的内容和知识，也可以畅所欲言、分享您的想法和见解。

推荐:kwan 的首页,持续学习,不断总结,共同进步,活到老学到老
导航
檀越剑指大厂系列:全面总结 java 核心技术,jvm,并发编程 redis,kafka,Spring,微服务等
常用开发工具系列:常用的开发工具,IDEA,Mac,Alfred,Git,typora 等
数据库系列:详细总结了常用数据库 mysql 技术点,以及工作中遇到的 mysql 问题等
新空间代码工作室:提供各种软件服务,承接各种毕业设计,毕业论文等
懒人运维系列:总结好用的命令,解放双手不香吗?能用一个命令完成绝不用两个操作
数据结构与算法系列:总结数据结构和算法,不同类型针对性训练,提升编程思维,剑指大厂

非常期待和您一起在这个小小的网络世界里共同探索、学习和成长。💝💝💝 ✨✨ 欢迎订阅本专栏 ✨✨

博客目录

- 1.问题描述
- 2.问题分析
- 3.解决方案
- 4.最佳实践
- 5.结论

在 FastAPI 框架中，路由的配置是构建 RESTful API 的关键步骤。路由配置不仅需要正确地定义路径参数，还需要正确地处理非路径参数，以确保 API 的访问逻辑清晰且正确。然而，当路径参数和非路径参数的前缀一致时，可能会出现一些混淆，导致非预期的路由行为。本文将通过分析给出的代码示例，探讨这一问题，并提供相应的解决方案。
在这里插入图片描述

1.问题描述

在提供的代码示例中，我们可以看到两个路由装饰器@KBRouter.post被应用于两个不同的函数。第一个函数get接收一个路径参数id，而第二个函数get则没有路径参数，但接收一个非路径参数info。两个函数的路由路径前缀都是/collection/docs，这可能导致一些混淆。

FastAPI 路径参数和非路径参数的前缀一致,当访问非路径参数的接口时,会走到路径参数的接口中

@staticmethod
@KBRouter.post("/collection/docs/{id}", description="路径参数接口",
               summary="路径参数接口")
async def get(id: str = None):
    return {
        "code": 0,
        "data": None,
        "msg": "成功"
    }

@staticmethod
@KBRouter.post("/collection/docs/add", description="非路径参数接口",
               summary="非路径参数接口")
async def get(info: str = None):
    return {
        "code": 0,
        "data": None,
        "msg": "成功",
    }

2.问题分析

FastAPI 使用基于 Python 类型提示的参数来定义路径参数和查询参数。路径参数通过在函数参数中使用Path来声明，而非路径参数则直接作为函数参数声明。在上述代码中，第一个get函数使用Path来声明路径参数id，而第二个get函数则直接声明了非路径参数info。

问题出现在两个函数的路由路径前缀相同，但一个是路径参数，另一个是非路径参数。当客户端发送请求到/collection/docs/add时，FastAPI 可能会错误地将请求路由到第一个get函数，因为add可以被解释为id的值。

3.解决方案

为了解决这个问题，我们需要确保路径参数和非路径参数的路由清晰区分。以下是几种可能的解决方案：

更改非路径参数的路由前缀：最简单的方法是更改第二个get函数的路由前缀，以避免与路径参数的前缀冲突。例如，可以将/collection/docs/add更改为/collection/docs/non_path。
使用不同的 HTTP 方法：如果逻辑允许，可以考虑为两个接口使用不同的 HTTP 方法，比如 GET 和 POST，这样可以在不改变路由前缀的情况下区分它们。
明确区分路径参数和非路径参数：在设计 API 时，应该明确区分路径参数和非路径参数的使用场景，避免在同一个前缀下同时使用它们。
使用请求体来传递非路径参数：如果非路径参数的数据量较大或者需要更复杂的数据结构，可以考虑使用请求体（如 JSON）来传递这些参数，而不是通过查询参数。
增加 API 文档和版本控制：通过增加详细的 API 文档和版本控制，可以帮助开发者和用户更好地理解 API 的使用方法，减少因路由混淆导致的错误。