FastAPI从入门到实战(15)——设置通用路由

本文主要记录fastapi实现一个接口多个请求方式的实现;例如同样的接口,既可以通过查询参数或路径参数的方式请求得到数据,也可以通过发送请求体的方式得到响应。

常见的请求方式

  1. Get 向特定资源发出请求(请求指定页面信息,并返回实体主体)
  2. Post 向指定资源提交数据进行处理请求(提交表单、上传文件),又可能导致新的资源的建立或原有资源的修改
  3. Put 向指定资源位置上上传其最新内容(从客户端向服务器传送的数据取代指定文档的内容)
  4. Head 与服务器索与get请求一致的相应,响应体不会返回,获取包含在小消息头中的原信息(与get请求类似,返回的响应中没有具体内容,用于获取报头)
  5. Delete 请求服务器删除request-URL所标示的资源*(请求服务器删除页面)
  6. Trace 回显服务器收到的请求,用于测试和诊断
  7. opions 返回服务器针对特定资源所支持的HTML请求方法 或web服务器发送*测试服务器功能(允许客户端查看服务器性能)
  8. Connect HTTP/1.1协议中能够将连接改为管道方式的代理服务器
  • get请求无消息体,只能携带少量数据,且不安全;get请求将数据放在url地址中
  • post请求有消息体,可以携带大量数据,且安全;post请求将数据放在消息体body中
  • GET方式提交的数据最多只能有1024字节,而POST则没有此限制。

FastAPI设置通用路由

FastAPI内写接口都是通过@app.methods的方式实现的,这样的方式限定了请求方式为某一种,在某些场景下不能满足我们的开发需求,所以需要实现同一路由多种请求方式。这里的@appmethods都是代指,官网上也没写,看了一下github和源码,大致弄明白了;

源码

从这里就能看出来,上面的那种实现方式也是依赖于api_route方法,所以直接利用api_route方法实现即可。

 def get(
        self,
        path: str,
        *,
        ......
    ) -> Callable[[DecoratedCallable], DecoratedCallable]:
        return self.api_route(
            path=path,
            response_model=response_model,
            status_code=status_code,
            tags=tags,
            dependencies=dependencies,
            summary=summary,
            description=description,
            response_description=response_description,
            responses=responses,
            deprecated=deprecated,
            methods=["GET"],
            operation_id=operation_id,
            ......
        )

代码实现

@app.api_route("/test", methods=["GET", "POST", "DELETE"])
async def test(request: Request):
    return {"method": request.method}

如上,方法就很简单,利用api_route方法,设置路径,同时设置methods列表即可,文档与测试如下:

image-20221215113834317

image-20221215113856955

image-20221215113918562

image-20221215113937127


感谢阅读!

九陌斋地址:https://blog.jiumoz.com/archives/fastapi-cong-ru-men-dao-shi-zhan-15-she-zhi-tong-yong-lu-you

欢 迎 关 注 博 主 个 人 小 程 序!
  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
### 回答1: FastAPI 是一个 Python Web 框架,可用于快速构建 API。 要在 FastAPI设置通用路径,您可以使用 `prefix` 参数。例如,如果要设置所有路由的前缀为 `/api`,您可以在路由装饰器(如 `@app.get`)的上方添加 `@app.prefix("/api")` 装饰器。 例如: ```python from fastapi import FastAPI app = FastAPI() @app.prefix("/api") @app.get("/users/{user_id}") async def read_user(user_id: int): return {"user_id": user_id} ``` 在这个例子中,路由的实际路径将是 `/api/users/{user_id}`。 如果要设置多个路由的前缀,可以使用 `app.include_router` 函数,并传递路由对象以及要设置的前缀。例如: ```python from fastapi import FastAPI from fastapi import APIRouter app = FastAPI() router = APIRouter() @router.get("/users/{user_id}") async def read_user(user_id: int): return {"user_id": user_id} app.include_router(router, prefix="/api") ``` 在这个例子中,路由的实际路径将是 `/api/users/{user_id}`。 希望这些信息对您有帮助。 ### 回答2: FastAPI是一个快速(fast)和易于使用的Web框架,可以轻松地设置通用路径。 要设置通用路径,首先需要导入FastAPI库并创建一个应用程序实例。然后,可以使用装饰器(Decorators)来定义路由处理程序。装饰器的名称决定了路径的一部分,函数的名称决定了方法的一部分。 例如,下面的代码演示了如何设置通用路径: ``` from fastapi import FastAPI app = FastAPI() @app.get("/items/{item_id}") async def read_item(item_id: int): return {"item_id": item_id} ``` 在这个例子中,使用了`@app.get`装饰器将`read_item`函数绑定到`/items/{item_id}`路径上。`{item_id}`是一个路径参数,可以在函数的参数列表中进行使用。当用户访问`/items/1`时,该函数会返回`{"item_id": 1}`。 为了使路径参数成为可选的,可以使用默认值。例如,下面的代码所示: ``` @app.get("/items/{item_id}") async def read_item(item_id: int, q: str = None): return {"item_id": item_id, "q": q} ``` 在这个例子中,`q`是一个可选的查询参数。当用户访问`/items/1?q=test`时,函数会返回`{"item_id": 1, "q": "test"}`。如果用户只访问`/items/1`,函数会返回`{"item_id": 1, "q": None}`。 使用FastAPI通用路径可以轻松地处理不同的请求,从而实现灵活和高效的API开发。以上仅是对设置通用路径的简单介绍,更多关于FastAPI的功能和用法可以参考官方文档。 ### 回答3: FastAPI可以通过使用公共路径设置来管理API端点的URL结构。公共路径是在应用程序级别定义的路径,可以在多个路由中重复使用。 要设置公共路径,首先需要创建一个FastAPI应用程序实例,并使用`APIRouter`创建一个路由器对象。 ```python from fastapi import FastAPI, APIRouter app = FastAPI() router = APIRouter() ``` 然后,可以使用路由器对象的装饰器方法(如`@router.route()`)为不同的API端点添加具体的路径。 ```python @router.get("/endpoint1") def endpoint1(): return {"message": "This is endpoint 1"} @router.get("/endpoint2") def endpoint2(): return {"message": "This is endpoint 2"} ``` 最后,将路由器添加到FastAPI应用程序实例中。 ```python app.include_router(router, prefix="/api") ``` 在上面的示例中,路由器中的端点路径将添加到公共路径`/api`之后。因此,实际的API端点路径将是`/api/endpoint1`和`/api/endpoint2`。 通过设置公共路径,我们可以更好地组织和管理API的URL结构,提高代码的可维护性和可重用性。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

九陌斋

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值