如何将外部 swagger json 文件链接到 Python FastAPI？

【问题标题】：How to link an external swagger json file to Python FastAPI?如何将外部 swagger json 文件链接到 Python FastAPI？
【发布时间】：2021-02-23 11:50:27
【问题描述】：

我有一个大张旗鼓的 JSON 文件，我想链接到我的 Python FastAPI 脚本来替换默认的 /docs 自动生成的文件，知道如何实现吗？

【问题讨论】：

为什么要这样做？
在 swagger 编辑器中创建和编辑文档比在 FastAPI 脚本中更容易。

标签： python python-3.x api swagger fastapi

【解决方案1】：

没有内置方法可以做到这一点，但您可以通过关注the documentation 轻松覆盖/扩展openapi 代。

这是一个关于如何达到预期结果的小代码示例：

from fastapi import FastAPI
import json

app = FastAPI()

def custom_openapi():
    with open("openapi.json", "r") as openapi:
        return json.load(openapi)

app.openapi = custom_openapi

结果：

请注意，尽管使用这种方法使文档保持最新和准确会很痛苦，而且您会丢弃大量 FastAPIs 功能集：我强烈建议不要这样做。

【讨论】：