微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

FastAPI/Redoc 创建的“openapi.json”缺少枚举参数的“type”键

如何解决FastAPI/Redoc 创建的“openapi.json”缺少枚举参数的“type”键

我有一个使用 FastAPI 的 REST API 构建,各种查询字符串参数都可以正常工作,生成有效的 openapi.json 输出

flagged: bool = False,

生成

{
  "required": false,"schema": {
    "title": "Flagged","type": "boolean"
  },"name": "flagged","in": "query"
}

但是我有一些使用枚举值的参数。生成的 openAPI 定义缺少 type 说明符 -

sortby: TaskSortby = TaskSortby.confusion,

生成

 {
  "required": false,"schema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/TaskSortby"
      }
    ],"default": "confusion"
  },"name": "sortby","in": "query"
}

如您所见,缺少 schema.type,这会导致读取 openapi.json 文件的其他工具损坏。

如何为枚举参数生成带有 openapi.json 键的 type

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。