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的方式实现的，这样的方式限定了请求方式为某一种，在某些场景下不能满足我们的开发需求，所以需要实现同一路由多种请求方式。这里的@app和methods都是代指，官网上也没写，看了一下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://cloud.tencent.com/developer/support-plan?invite_code=1gih9vl5y1mrs