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

编程问答 2022-05-27

问题描述

我有一个使用 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 (将#修改为@）

fastapiopenapipythonredocrestrest