小编Sal*_*mbo的帖子

如何使用 FastAPI 将图像添加到 Swagger UI autodocs?

我想将图像添加到 FastAPI 自动文档(由 Swagger UI 提供),但我不知道如何执行此操作。这是代码:

@api.get(path='/carbon-credit/',
    responses={
        200: {'description': 'Ok',
            "content": {
            "image/jpeg": {
                "example": 'https://picsum.photos/seed/picsum/200/300'
                    }
                }},
        404: {"description": "not found"},
        422: {'description': 'not found 2'},
    },
    name='API for Carbon Credit',
    description="get carbon credit",
    tags=['Images'],
    response_class=Response)
Run Code Online (Sandbox Code Playgroud)

正如您从代码中看到的,我尝试使用 URL 来执行此操作,而我在 ReDoc 和 Swagger UI 中得到的只是文本形式的 URL,而不是实际图像。另外,我想使用存储在本地驱动器中的图像。

Swagger UI 和 ReDoc 的屏幕截图: 重新文档

昂首阔步

我怎样才能做到这一点?

提前致谢。

python swagger swagger-ui openapi fastapi

1
推荐指数
1
解决办法
2827
查看次数

标签 统计

fastapi ×1

openapi ×1

python ×1

swagger ×1

swagger-ui ×1