FastApi 模式额外换行

Question

我正在尝试在 FastAPI 中添加端点示例（根据 https://fastapi.tiangolo.com/it/tutorial/schema-extra-example/），其中一个字段需要多行注释，但是我尝试我做不到。我应该添加什么才能将其分成多行。

我已经尝试过：

• 多行Python字符串（ )

• <br>

• <br />

• \ 位于行尾
• 行尾有两个空格

没有任何效果，无论我做什么，Swagger UI 都会显示原始字符串。

Answer 1

您可以使用 fastapi

Query()

对象（特别是使用

description

属性）向 Swagger 端点添加文档。

注意压痕的细节。使用多行字符串时，您必须从第一列开始。

看下面的例子。

query_foo = Query(
    description="""
Pass a `foo` parameter to do amazing things

## Allowed values

- **this**
- **that**

Sadly `bar` is not allowed 😔 (_some day it will be_).
""",
    openapi_examples={
        "red": {
            "summary": "this is the value shown in the dropdown",
            "description": "This is the description shown once you select the option",
            "value": "red",
        },
            
    },
)