如何用另一个swagger文档扩展FastAPI文档？
Swagger是一种描述、生成、消费RESTful风格API的工具集，FastAPI是一个快速（高性能）Web框架，用于构建基于Python的API。Swagger提供了一个规范化的方式来描述API的细节，包括请求和响应的数据结构、参数等信息，而FastAPI则使用这些信息来自动生成API文档和处理请求。
如果想要用另一个Swagger文档扩展FastAPI文档，可以按照以下步骤进行操作：
- 下载并安装FastAPI和相关依赖：
pip install fastapi
pip install uvicorn- 创建一个新的Python文件，导入必要的库：
from fastapi import FastAPI
import yaml- 加载并解析另一个Swagger文档：
with open("path/to/another/swagger.yaml", "r") as file:
another_swagger = yaml.safe_load(file)- 创建FastAPI应用程序实例：
app = FastAPI()- 扩展FastAPI文档：
@app.get("/docs")
def get_docs():
# 获取FastAPI生成的文档
docs = app.openapi()
# 将另一个Swagger文档中的路径和操作添加到FastAPI文档中
for path, path_item in another_swagger.get("paths", {}).items():
if path not in docs.get("paths", {}):
docs["paths"][path] = path_item
else:
for method, operation in path_item.items():
if method not in docs["paths"][path]:
docs["paths"][path][method] = operation
return docs通过上述步骤，我们将另一个Swagger文档中的路径和操作添加到了FastAPI生成的文档中。在上面的代码中，我们将另一个Swagger文档存储在变量another_swagger中，并将其路径和操作迭代添加到FastAPI文档的相应部分。
这样，通过访问/docs路径，您将获得包含另一个Swagger文档扩展的FastAPI文档。
请注意，由于各种Swagger文档的格式和结构可能不同，您需要根据实际情况进行适当的解析和调整。此外，您还可以通过修改上述代码来满足特定的要求，例如处理冲突或者合并其他信息。
对于腾讯云的相关产品和产品介绍链接，可以参考腾讯云官方文档或者通过腾讯云官方网站获取更多详细信息。
相关·内容
我正在尝试自定义由FastAPI生成的FastAPI (Swagger )文档，但是字符串- Swagger UI仍然存在。
app = FastAPI(
title="Test",
version="0.1.0"
)
HTML结果：
<title>Test - Swagger UI</title>
有没有办法从标题中删除这个- Swagger UI？
浏览 9提问于2022-03-10得票数 3
1回答
如何使用Office365返回excel文件(版本: FastAPI )？文档看起来很简单。但是，我不知道该使用什么media_type。这是我的密码：
import os
from fastapi import FastAPI
from fastapi.responses import FileResponse
from pydantic import BaseModel
from typing import Optional
excel_file_path = r"C:\Users\some_path\the_excel_file.xlsx"
app = FastAPI
浏览 33提问于2022-04-29得票数 3
回答已采纳
1回答
我是新来的FastApi，和孔API-网关！
我正在尝试从江港API网关调用fastAPI应用程序。
fastAPI应用程序运行良好，但当我尝试从Kong访问它(将其作为服务添加并为服务配置路由后)，它将失败，显示以下错误：
Failed to load API definition.
Fetch error
Not Found /openapi.json
FastAPI代码如下：
from typing import Union
from fastapi.openapi.docs import (
get_redoc_html,
get_swagger_ui_html,
浏览 48提问于2022-10-19得票数 0
我有一个FastAPI应用程序，它返回一个HTMLResponse。代码简单明了，如FastAPI的中的示例所示。响应工作正常，但是Swagger显示原始的HTML内容。有办法显示实际的HTML页面吗？
from fastapi import FastAPI
from fastapi.responses import HTMLResponse
app = FastAPI()
@app.get("/items/")
async def read_items():
html_content = """
<html>
浏览 13提问于2022-11-11得票数 1
我试图隐藏FastAPI生成的swagger文档的整个模式部分。我已经检查了文档并尝试了这一点，但是模式部分仍然显示。
@Schema(hidden=True)
class theSchema(BaseModel):
category: str
如何从返回的swagger文档中省略一个特定模式或整个架构部分。
docExpansion似乎也不起作用。我遗漏了什么？
app = FastAPI(
openapi_tags=tags_metadata,
title="Documentation",
description=&#
浏览 20提问于2022-01-20得票数 3
回答已采纳
我希望将我的自定义javascript文件或代码加载到FastAPI Swagger网页中，以便在创建FastAPI对象时添加一些动态交互。
例如，在docs网页上的Swagger中，我想
<script src="custom_script.js"></script>
或
<script> alert('worked!') </script>
我试过：
api = FastAPI(docs_url=None)
api.mount("/static", StaticFiles(directory
浏览 16提问于2022-12-02得票数 2
2回答
我需要将"/swagger-ui.html“重定向到文档页面。
我试过：
app = FastAPI()
@app.get("/swagger-ui.html")
async def docs_redirect():
response = RedirectResponse(url='/docs')
return response
和
app = FastAPI(docs_url="/swagger-ui.html")
@app.get("/")
async def docs_redirect():
浏览 7提问于2021-02-10得票数 1
回答已采纳
我正在构建一个FastAPI应用程序，它有很多Pydantic模型。尽管应用程序工作得很好，但正如预期的那样，OpenAPI (Swagger )文档不会在Schemas部分中显示所有这些模型的模式。
这是化脓性schemas.py的内容
import socket
from datetime import datetime
from enum import Enum
from typing import Any, Dict, List, Optional, Set, Union
from pydantic import BaseModel, Field, validator
from ty
浏览 9提问于2022-04-20得票数 5
我正在尝试使用POST做一个简单的FastAPI操作。我使用BaseModel创建了一个基本结构，它只有两个属性，即name和roll。
import uvicorn
from fastapi import FastAPI
from pydantic import BaseModel
class Item(BaseModel):
name: str
roll: int
app = FastAPI()
@app.post("/")
async def create_item(item: Item):
return item
if __name__
浏览 4提问于2022-04-04得票数 2
1回答
这是我的FastAPI main.py文件。
from fastapi import FastAPI
from project.config.settings import base as settings
app = FastAPI(docs_url=f"{settings.URL_ROOT}/{settings.DOCS_URL}", redoc_url=None)
app.openapi_version = "3.0.0"
# some functions here
我把这个项目部署到一个服务器上。但是，当我转到服务器1.2.3.4/url_root/
浏览 66提问于2022-02-18得票数 5
1回答
我决定在Python的FastApi框架中创建一个微服务网关。我的授权服务是用Django编写的，并且已经由drf-yasg包swagger文档生成。我在想是否有办法以某种方式将auth的模式导入到网关中。我可以通过http提供json格式的模式，并从网关访问它。问题是如何将FastApi的文档与原始的swagger模式文件集成。
浏览 29提问于2020-10-17得票数 3
回答已采纳
想象一下有一个这样的应用程序：
from fastapi import FastAPI
app = FastAPI()
@app.get("/items/{item_id}")
async def read_item(item_id: int):
return {"item_id": item_id}
如何在swagger中添加路径参数item_id的描述？
浏览 6提问于2022-03-08得票数 2
回答已采纳
如果我向这个接口发送一个请求： from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class Response(BaseModel):
var_name: str
@app.put("/", response_model=Response)
def simple_server(a: str):
response = Response(var_name=a)
return response 我得到了一个响应，这个json文件是{"var_n
浏览 24提问于2021-11-04得票数 2
回答已采纳
1回答
我想将“授权”标题添加到我的FastAPI应用程序中。我是由完成的，但是当我尝试在swagger中执行请求时-它不工作(swagger不使用自定义标头)，我有“丢失授权头”错误
浏览 3提问于2021-10-05得票数 0
回答已采纳
如果我使用依赖系统，有没有办法将字段描述添加到FastAPI swagger模式？ 我看不到可以在FastAPI docs的简单示例中添加描述的地方 async def common_parameters(q: str = None, skip: int = 0, limit: int = 100):
return {"q": q, "skip": skip, "limit": limit}
浏览 24提问于2021-01-28得票数 0
1回答
我有一个TensorFlow 模型，其形式是h5文件。
如何上传图像并在NumPy中返回FastAPI数组？
import numpy as np
import cv2
from fastapi import FastAPI, File, UploadFile
import numpy as np
from tensorflow.keras.models import load_model
import tensorflow as tf
model=load_model("complete_model.h5")
app = FastAPI()
def prepare(im
浏览 16提问于2022-02-13得票数 1
回答已采纳
我开始使用FastAPI框架进行编程，它附带了一个内置的Swagger接口来处理请求和响应。我已经完成了将近20个API，它很难管理和识别Swagger界面上的API。有人告诉我在Swagger接口中添加部分来区分API，但是我找不到任何例子，我需要帮助。
浏览 2提问于2020-09-06得票数 10
回答已采纳
1回答
我的项目目录结构如下：
.
├── .env
│ ├── Include
│ ├── Lib
│ ├── Scripts
│ └── pyvenv.cfg
├── .vscode
│ └── launch.json
└── src
├── __pycache__
└── main.py
我在main.py文件中编写了一些代码：
import fastapi
from fastapi import FastAPI
app=FastAPI()
@app.get("/")
def health():
return "ok"
浏览 14提问于2022-09-22得票数 0
回答已采纳
我有一个FastAPI应用程序，它实现了这样的路由。
from fastapi import FastAPI
api = FastAPI()
@api.post("/myroute/")
def myroute(a: str, b: str) -> str:
return f"a={a}, b={b}"
当我运行服务器并使用Swagger与其交互时，它可以正常工作。
我有下面的单元测试。
from fastapi.testclient import TestClient
def test_myroute():
client = Tes
浏览 11提问于2022-08-24得票数 0
回答已采纳
如何为FastAPI Swagger自动文档中的API方法设置排序顺序？我希望我的所有方法按类型分组(GET、POST、PUT、DELETE)。
展示了如何在Java中实现它。我怎么用Python来做呢？
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
def list_all_components():
pass
@app.get("/{component_id}")
def get_component(component_id: int):
pass
@app.pos
浏览 10提问于2022-07-07得票数 2
回答已采纳
2回答
我搞不懂为什么要观察方法调用的不同输出，这取决于是否包含了额外的库。
在解析Swaggerv1.2Doc时，我观察到了不同的结果，不管有没有swagger-compat-spec-parser库。
注意，在下面的输出中，我运行Scala编程语言的REPL。
将Swagger文档解析为无null swagger-compat-spec-parser 库的库
$cat build.sbt
libraryDependencies += "io.swagger" % "swagger-parser" % "1.0.17"
$sbt console
s
浏览 3提问于2016-02-19得票数 0
回答已采纳
我已经将一个简单的快速api部署到aws网关.All，端点运行良好，但是我无法加载我在下面看到的swagger文档页面。
Api代码：
from fastapi import FastAPI
from mangum import Mangum
import os
from fastapi.middleware.cors import CORSMiddleware
stage = os.environ.get('STAGE', None)
openapi_prefix = f"/{stage}" if stage else "/"
app
浏览 1提问于2022-05-24得票数 2
我正在尝试用clientsecret设置FastAPI (0.71.0)身份验证。
我配置了OAuth2AuthorizationCodeBearer，显然从swagger (/docs)端点看上去很好，它要求客户端id和客户端秘密进行身份验证。
auth = OAuth2PasswordBearer(
authorizationUrl=AUTH_URL,
tokenUrl=TOKEN_URL,
)
agent = FastAPI(
description=_DESCRIPTION,
version=VERSION,
dependencies=[Dep
浏览 5提问于2022-01-19得票数 2
回答已采纳
我已经安装并实现了快速and本地化，就像快速and本地化的pypi.org文档页面中说的那样，它没有相应地转换响应。，谁能建议我如何用不同的语言来修正这个或其他更好的方法来翻译API响应呢？提前谢谢。。
我的代码和文件上写的一模一样-
from fastapi_localization import TranslateJsonResponse
from fastapi_localization import TranslatableStringField
from typing import List
from pydantic import BaseModel
class Language
浏览 5提问于2022-03-16得票数 1
FastAPI生成自动的swagger/openapi文档。
在的教程中有一个例子
from fastapi import FastAPI
app = FastAPI()
@app.post("/items/", status_code=201)
async def create_item(name: str):
return {"name": name}
如果运行此选项，./docs页面将显示两个http响应选项：
状态代码201表示成功，状态代码422表示验证错误
上面的教程显示了这个页面的图片。
)
我想在文档中记录更多的响应status_co
浏览 4提问于2020-07-02得票数 9
回答已采纳
4回答
我有一个基于FastAPI的应用程序，作为网站的后端，目前部署在一个外部IP的服务器上。前端位于另一个开发人员，暂时在本地托管。在工作开始时，我们遇到了CORS问题，通过使用我在互联网上找到的以下代码解决了这个问题：
from fastapi.middleware.cors import CORSMiddleware
...
app.add_middleware(
CORSMiddleware,
allow_origins=['http://localhost:3000'],
allow_credentials=True,
allow_metho
浏览 0提问于2020-09-30得票数 0
1回答
我正在使用
我在我的app.js中安装了像下面这样的swagger文档
//include swagger js doc
var swaggerJSDoc = require('swagger-jsdoc');
const swaggerUi = require('swagger-ui-express');
const pathToSwaggerUi = require('swagger-ui-dist').absolutePath()
const swaggerDefinition = {
swagger: '2.0
浏览 1提问于2019-05-01得票数 1
使用FastAPI，我试图注入两个独立的函数，每个函数都有自己的pydantic请求体，并将它们构成另一个端点的路径操作的单独端点的一部分。请参考下面的示例进行说明： from fastapi import FastAPI, Depends
from pydantic import BaseModel
app = FastAPI()
class RequestBodyChild1(BaseModel):
item1: float
item2: float
class RequestBody1(BaseModel):
parent1: RequestBodyChi
浏览 23提问于2021-10-28得票数 1
回答已采纳
我正在我的mvc web应用程序(而不是webapi)中编写web服务端点(作为一个区域：‘api’)。有没有人可以告诉我如何用一个区域来配置swagger？ services.AddSwaggerGen();
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("api/swagger/v1/swagger.json", "MY API V1");
c.RoutePrefix = "api";
});
浏览 5提问于2020-11-05得票数 0
回答已采纳
我试图在一个Docker容器中部署FastAPI应用程序+前端，所以我不想添加NginX或另一个web服务器，因为这会使设置复杂化。
我的路线应该是这样的：
/ <-- should serve index.html
/{id} <-- should serve index.html, but only when {id} is int
/css/* <-- should serve files from css directory
/... <-- a few other static files (e.g. /service-worker.js)
/api/<
浏览 16提问于2021-12-08得票数 1
非常新的编码，并已通过一个FastAPI在线视频课程。了解CRUD操作人员并进行操作。在这节课中，我理解了关于get的第一个基本知识：
from fastapi import FastAPI
app = FastAPI()
STUDENTS = {
'student_1': {'fullname': 'Tom Hanks', 'address': 'Hollywood', 'dob': 'July 27', 'citizenship': '1234
浏览 2提问于2022-06-08得票数 0
我希望在我的FastAPI应用程序中集成基于Cookie的身份验证。我也想要同样的工作与昂首阔步的无缝工作。
我想要一条设置浏览器cookie的路径(例如：/login)。所有其他受保护的路由都在装饰器中使用Depends来验证cookie中的密钥。我如何使它与OpenAPI授权按钮一起工作？
这里的重要因素是集成了由FastAPI自动生成的Swagger/OpenAPI文档。
浏览 11提问于2021-03-27得票数 1
使用ORM，我希望执行POST请求，允许一些字段具有null值，这些字段将在数据库中转换为指定的默认值。
问题是OpenAPI (Swagger) 文档忽略默认的None，默认情况下仍然提示一个UUID。
from fastapi import FastAPI
from pydantic import BaseModel
from typing import Optional
from uuid import UUID
import uvicorn
class Table(BaseModel):
# ID: Optional[UUID] # the docs show a
浏览 9提问于2022-05-12得票数 2
回答已采纳
我有一个docker-compose.yml文件如下：
version: "3.8"
x-aws-loadbalancer: "arn:aws:elasticloadbalancing:my-load-balancer"
services:
fastapi:
image: username/auth:FastAPI
x-aws-pull_credentials: "arn:aws:secretsmanager:us-west-2:creds"
build: FastAPI
ports:
- "
浏览 18提问于2022-04-03得票数 2
回答已采纳
我试图在我的.Net核心WebAPI应用程序中引入URL版本控制。我也在使用Swagger网站工具，以方便用户使用。
现在，在尝试将版本控制引入我的应用程序时，我在这里引用了文档：
现在，我在代码中做了以下代码更改：
Startup.cs/ConfigureServices我在下面添加了代码：
services.AddApiVersioning(options => {
options.AssumeDefaultVersionWhenUnspecified = true;
});
在添加任何版本之前，我的控制器注释如
浏览 1提问于2018-10-16得票数 0
回答已采纳
是否有任何用于节点表达式的工具，您可以在其中为现有的项目自动生成swagger文档？类似于斯巴什扣？
浏览 2提问于2015-11-17得票数 8
回答已采纳
突然，FastAPI的Swagger UI停止工作。这同时发生在我的开发服务器和生产服务器上，使用的是不同的代码库。 API本身似乎工作正常，但Swagger中的端点不能正确扩展。 这是在单击其中一个项目"/sat-players/“之前的UI ? 这是它点击后的样子。该项目移动到一个新的类别“默认”，这不是我创建的。 ? 由于它发生在两个服务器上，我怀疑Swagger正在从外部CDN更新像样式表这样的文件，这些文件存在问题。 你认为问题出在哪里？
浏览 70提问于2020-07-23得票数 1
1回答
请注意，这个最小的代码给了我这个请求: 400 {“detail”：“解析主体时出错了”}，但是它在swagger ui上工作很好。
main.py
import shutil
import uvicorn
from fastapi import FastAPI, File, UploadFile
app = FastAPI()
@app.post("/upload")
async def upload(file: UploadFile = File(...)):
try:
with open('save.txt', "w
浏览 1提问于2021-08-25得票数 0
1回答
我目前正在使用fastapi构建一个微服务。 我想通过graphql在另一个路径上公开我的底层数据。来自starlette的直接集成已经被弃用，所以我尝试使用推荐的包strawberry。目前，它似乎不可能与grapqhl结合使用。 示例 my_grapqhql.py from typing import List
import strawberry
@strawberry.type
class Book:
title: str
author: str
@strawberry.type
class Query:
books: List[Book]
schema
浏览 59提问于2021-07-15得票数 1
回答已采纳
我试图在PHP swagger中创建Restful文档，我之前所做的是更改JSON以解决问题，现在我知道我们可以通过创建PHP文件和使用swagger符号来生成JSON。我确实检查了Pet.php示例，并获得了代码，但我不知道如何执行该文件以获得JSON文档，我可以将该文档链接到Swagger。我读了这些文档，但它是如此混乱，我不知道如何解决这个问题，谁能帮上忙吗？这是我所研究但毫无价值的链接。
有人能一步一步地告诉我如何用JSON生成API文档吗？我会非常感谢他的，谢谢。
浏览 3提问于2014-09-18得票数 0
1回答
我正在使用Python FastAPI编写一些Rest API。需要在Swagger - OpenAPI文档中添加大量自定义部分。这包括每个API的联系信息字段、作者信息、显示数据模型的图像、数据库字段等。 有没有办法使用Fast API built-in OpenAPI capabilities来完成这一切？我知道可以托管我们自己的自定义json文件。但我不知道如何将图像添加到swagger json文件中。我也不知道如何添加自定义字段。 有没有什么模板可以用来托管swagger文档的HTML版本？ 任何帮助都将不胜感激。
浏览 19提问于2021-08-15得票数 1
我正在阅读关于路径参数验证的教程：。
我希望允许字符串"a“"b”和"c“作为可能的参数值。我希望这些值显示在OpenAPI文档()中，因此API用户不必猜测它们。如何使这些值显示在文档中？
以下是我的实现：
from fastapi import FastAPI, HTTPException
app = FastAPI()
parameters = ["a", "b", "c"]
@app.get("/endpoint/{parameter}")
def endpoint(parameter: st
浏览 3提问于2021-09-07得票数 1
我多次更改了$ref值，
但它们都揭示了同样的错误..。请帮我
怎么了？
swagger.js
import swaggereJsdoc from 'swagger-jsdoc';
const options = {
swaggerDefinition: {
info: {
title: 'User API',
version: '1.0.0',
description: 'User API with express',
},
host: 'localh
浏览 11提问于2022-07-16得票数 1
我有一些问题通过FastAPI插入到FastAPI中。
下面的代码按预期工作。注意response变量在response_to_mongo()中是如何没有被使用的。
model是一种滑雪ElasticNet模型。
app = FastAPI()
def response_to_mongo(r: dict):
client = pymongo.MongoClient("mongodb://mongo:27017")
db = client["models"]
model_collection = db["example-mode
浏览 30提问于2022-03-14得票数 2
回答已采纳
1回答
我使用一个FastAPI操作构建了一个测试GET实例，如下所示：
import uvicorn
from fastapi import FastAPI
from typing import List, Dict
app = FastAPI()
@app.get("/result/")
async def root(d: Dict, l: List):
keys = list(d.keys())
for i in range(len(keys)):
d[keys[i]] = d[keys[i]] + l[i]
return d
if
浏览 4提问于2021-12-16得票数 1
1回答
我正在尝试用Swagger编写一个应用程序接口(用gem swagger-docs在Rails中)。我有一些完整的基本文档。已运行sudo SD_LOG_LEVEL=1 rake swagger:docs RAILS_ENV=production，没有任何错误。
我的问题是，当导航到JSON时，Swagger UI不能显示我的所有文档。我可以查看单个文件/控制器(即users.json)，但是当我访问api-docs.json时，我可以看到版权和公司信息等，但我的API却看不到。
每个控制器都将其文档写入{root}/public/apis/v1/*.json。
截图：
浏览 1提问于2016-09-29得票数 0
我目前正在使用swagger ui的Quarkus，并在链接成功的https://quarkus.io/guides/openapi-swaggerui下面点击了一个链接来测试它。 但是，有没有办法在quarkus中使用swagger ui实现apache camel路由呢？请帮帮我。
浏览 50提问于2021-09-17得票数 0
现在，我只能通过在浏览器中手动输入API路径来查看PlainTextResponse。但是，我希望能够在自己的Swagger中查看PlainTextResponses。每次我尝试请求一个OpenAPI时，似乎都会无限期地加载PlainTextResponse
以下是一个示例：
from fastapi import FastAPI
from fastapi.responses import PlainTextResponse
import pandas as pd
app = FastAPI()
@app.get("/plain_text", response_class=
浏览 13提问于2022-07-04得票数 -1
回答已采纳
我试图使用FastAPI来允许我的(dockerized)服务器响应返回的API调用。
additional_dict a image image和a字典image
(对于机器学习示例，这可能是来自分类器的分类标签和显着性映射)。
在我的例子中，我认为使用相同的端点获取两个对象是有意义的，因为它们是用相同的计算生成的。
我可以使用类似于的内容，成功地以二进制形式返回图像
from PIL import Image
from fastapi import FastAPI, File
import tempfile
from starlette.responses import FileRespo
浏览 12提问于2020-01-15得票数 4
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
腾讯会议
实时音视频活动推荐
腾讯云开发者
