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

2024-04-26 14:02:38 发布

您现在位置:Python中文网/ 问答频道 /正文

我有一个招摇过市的JSON文件,我想链接到我的Python FastAPI脚本来替换默认的/docs自动生成的一个,你知道我该如何实现吗


Tags: 文件脚本jsondocs链接fastapi
1条回答
网友
1楼 · 发布于 2024-04-26 14:02:38

没有内置的方法可以做到这一点,但是您可以通过遵循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

结果是:

Custom OpenAPI

请注意,使用这种方法使文档保持最新和准确将是一件痛苦的事情,而且您正在丢弃大量的FastAPI特性集:我强烈建议不要这样做

相关问题 更多 >