【FastAPI】1-url参数

fastapi的核心功能是提供HTTP请求接口

  • "幂等"和"非幂等"
    幂等(idempotent):如果一个方法重复执行多次,产生的效果是一样的,那么这个方法就是幂等的

"Methods can also have the property of "idempotence" in that the side-effects of N > 0 identical requests is the same as for a single request."

安全和幂等的意义在于:当操作没有达到预期的目标时,我们可以不停的重试,而不会对资源产生副作用。

  • 最常见的HTTP请求方法及其幂等性:
    GET、DELETE、POST、PUT

    在开发 API 时,通常使用特定的 HTTP 方法去执行特定的行为

通常使用:

POST:创 建数据。

GET: 读取数据。

PUT :更新数据。

DELET E:删除数据。

  • 在 OpenAPI 中,每一个 HTTP 方法都被称为「操作」

  • 路径参数 item_id 的值将作为参数 item_id 传递给开发者的函数

  • 所有的数据校验都由 Pydantic 在幕后完成

  • 预设值

  • 如果你有一个接收路径参数的路径操作,但你希望预先设定可能的有效参数值,则可以使用标准的 Python Enum 类型。

    创建一个 Enum 类 导入 Enum 并创建一个继承自 str 和 Enum 的子类。

    通过从 str 继承,API 文档将能够知道这些值必须为 string 类型并且能够正确地展示出来。

    然后创建具有固定值class ModelName(str, Enum),的类属性,这些固定值将是可

    然后使用你定义的枚举类(ModelName)创建一个带有类型标注的路径参数async def get_model(model_name: ModelName)的有效值

    可以使用 model_name.value 或通常来说 your_enum_member.value 来获取实际的值

  • 包含路径的路径参数

    可以使用直接来自 Starlette 的选项来声明一个包含路径的路径参数:
    /files/{file_path:path}

    在这种情况下,参数的名称为 file_path,结尾部分的 :path 说明该参数应匹配任意的路径

相关推荐
Ares-Wang15 小时前
FastAPI 数据验证 Pydantic Flask 用 WTForms
python·flask·fastapi
曲幽16 小时前
FastAPI自动生成的API文档太丑?我花了一晚上把它改成了客户愿意付费的样子
python·fastapi·web·swagger·openapi·scalar·docs
PieroPc2 天前
一个功能强大的 Web 端标签设计和打印工具,支持服务器端直接打印到局域网打印机。Fastapi + html
前端·html·fastapi
别抢我的锅包肉2 天前
FastAPI + Vue3 + Vite 跨域报错全解:从 `Access-Control-Allow-Origin missing` 到彻底修复
中间件·状态模式·fastapi
Chase_______2 天前
【FastAPI】内网/离线环境docs文档无法显示的解决方案
fastapi
小李云雾2 天前
FastAPI 后端开发:文件上传 + 表单提交
开发语言·python·lua·postman·fastapi
曲幽2 天前
告别手写 API 胶水代码:FastAPI 与 Vue 的“契约自动机” OpenAPI 实战
python·typescript·vue·fastapi·web·swagger·openapi·codegen
2401_835792544 天前
FastAPI 速通
windows·python·fastapi
海市公约4 天前
FastAPI入门实战:从零搭建到核心功能详解
fastapi·后端入门·异步编程·路由管理·python web开发·api设计·pydantic数据验证
曲幽4 天前
FastAPI + Vue 前后端分离实战:我的项目结构“避坑指南”
python·vue·fastapi·web·vite·proxy·cors·env