fastapi swagger在线接口文档报错

于 2024-07-01 18:08:24 发布
阅读量470 收藏 4
点赞数 13
分类专栏： fastapi 文章标签： fastapi
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/ithongchou/article/details/140106434
版权

fastapi swagger在线接口文档报错

1、报错信息

Unable to render this definition
The provided definition does not specify a valid version field.
Please indicate a valid Swagger or OpenAPI version field. Supported version fields are swagger: “2.0” and those that match openapi: 3.x.y (for example, openapi: 3.1.0).

截图
在这里插入图片描述

2、报错原因

我限制了指定路径不需要登录访问，其他路口都需要登录才能访问。但是日志会显示openapi.json访问成功
在这里插入图片描述

3、解决办法

设置openapi.json为可访问的接口地址(/docs为不需要登录也能访问的地址)

app = FastAPI(
了解本专栏 订阅专栏 解锁全文 超级会员免费看
hzw0510
关注
  • 13
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
订阅专栏
Fastapi Swagger乱码 /docs乱码 样式错误
qq_29622543的博客
05-20 2039
5月20日下午，发现FASTAPI的Swagger样式突然错乱了 询问群友发现也有这个问题，简单判断认定是CDN的js和css导致的问题。而原代码中cdn路径并没有指定具体版本，可能是有更新导致了样式不兼容。经过验证，发现部分fastapi版本源码库中并未对swagger的资源限制版本。所以我们手动修改一下应急。 临时处理 首先打开Fastapi包，打开openapi -> docs.py 修改js和css的地址： 修改为： swagger_js_url: str = "https
swagger遇到Unable to render this definition，版本不匹配错误
ja.guide
09-22 1万+
错误提示如下： Unable to render this definition The provided definition does not specify a valid version field. Please indicate a valid Swagger or OpenAPI version field. Supported version fields areswagger: "2.0"and those that matchopenapi: 3.0.n(for examp...
Swagger整合SpringBoot提示版本不对(Please indicate a valid Swagger or OpenAPI version field.)
m0_46451276的博客
02-23 541
放开了springsecurity的权限后可以正常进入，但是发现没有生成接口。1. 我是SpringSecurity拦截了资源导致了一直提示路径不对。2. 但是把springsecurity拦截关闭是可以正常运行的。4. 我就查看页面网络获取的资源--原来是v2开头。// 除上面外的所有请求全部需要鉴权认证。3. 然后找到了这位老哥。
探索高效API文档管理：@fastify/swagger
最新发布
gitblog_00017的博客
05-17 422
探索高效API文档管理：@fastify/swagger 项目地址:https://gitcode.com/fastify/fastify-swagger 在当今的Web服务开发中，清晰且规范的API文档是关键。它让开发者能够理解、集成和测试你的服务，从而提升协作效率。而@fastify/swagger就是这样一款针对Fastify框架的强大插件，帮助你轻松创建和管理遵循OpenAPI规范的Swa...
【大模型应用开发-FastAPI框架】(七)FastAPI自定义swagger详细参数
04-13 936
main.pydescription='API接口文档',app.include_router(index_api, tags=["首页"])app.include_router(user_api, tags=["用户接口"])app.include_router(news_api, tags=["新闻接口"])2、自定义接口分组信息入口文件定义好接口分组描述同时，每个入口文件中，也要跟和main中的tags保持一致效果展示。
java中swagger报错：Please indicate a valid Swagger or OpenAPI version field. Supported version fields ar
彭珂个人网的博客
04-01 6713
可以看到，有和我们提示信息一样的字眼 swagger 2.0 openApi 3.0。可以看到，已经可以正常打开使用了，当然如果还不行，你可以试下swagger 1.2的。
fastapi Swagger UI报错 ：Errors Fetch errorInternal Server Error /api/v1/openapi.json
m0_72639960的博客
06-25 559
问题：fastapi定义的无法对输出模型序列化。解决 ： 检查最近添加的输出模型 如果不好找。，先在注册路由中逐个排查。
FastAPI token认证踩坑----swagger 接口测试没有token
浪荡的三木君
06-08 3407
FastAPI的SwaggerUI在API调用中authorization：Bearer undefined 错误原因： 是我自定义了返回的数据结构，没有access_token，token_type这两个关键字 解决办法： FastAPI的SwaggerUI在API调用中包含您的令牌，请确保您的/token端点在响应中包含2个必需的关键字。 access_token：这应该是您的令牌值 token_type：此值应为 Bearer 所以您的返回应该是这样的， { access_token: 'ey
fastapi访问/docs和/redoc接口文档显示空白或无法加载
m0_52726759的博客
05-19 5007
这个问题是由于fastapi内置的接口文档使用的外网的cdn 我们在浏览器开发者工具中可以看到它请求了一个js脚本，这个脚本部署在国外，国内无法访问，导致页面卡死在这里，显示空白。 知道这个以后，我们可以讲这些静态资源配置到自己的本地，这些静态资源都在github上开源。 swagger-ui redoc 上面两个链接分别是fastapi两种模式下文档接口所需的静态资源开源地址。 这里我抽取出我们所需要的最少的资源放在我的百度网盘。 提取码：33kh 将静态资源下载后放到项目的根目录下，
swagger文档无法访问
benniaofei18的博客
04-15 1807
.
Swagger..Unable to render this definition The provided definition does not specify a valid version
热门推荐
Daioo 随笔
05-02 2万+
Unable to render this definition The provided definition does not specify a valid version field. Please indicate a valid Swagger or OpenAPI version field. Supported version fields are swagger: “2.0” ...
使用node生成swagger接口文档
01-08
总结来说，使用Node.js和Swagger生成接口文档，可以大大提高开发效率，确保团队成员对API的一致理解和使用。这种方法不仅减少了手动编写文档的工作量，还使得接口文档与代码同步更新，降低了文档维护的难度。通过...
swagger接口文档改良添加左侧菜单.rar
07-28
Swagger接口文档改良添加左侧菜单是针对API开发过程中的一个重要优化，旨在提高开发人员对API文档的使用效率。Swagger是一款流行的RESTful API文档工具，它能够自动生成、描述、测试和发现Web服务接口。通过在...
asp.net webapi集成swagger自动生成接口文档(亲测可用)
03-25
asp.net webapi集成swagger自动生成接口文档(亲测可用)swagger生成html离线接口文档swagger生成html离线接口文档
Go语言使用swagger生成接口文档的方法
12-16
swagger介绍 Swagger本质上是一种用于描述使用JSON表示的RESTful ...最好是有一种方案能够既满足我们输出文档的需要又能随代码的变更自动更新，而Swagger正是那种能帮我们解决接口文档问题的工具。 这里以gin框架为例
swagger在线文档转成word文档
09-27
.description("API接口文档") .version("1.0") .build(); } } ``` 接下来，当Swagger2配置完成后，我们可以通过访问`http://localhost:8080/swagger-ui.html`来查看生成的在线文档。这个页面展示了所有API的...
swagger-ui.html渲染出错：Please indicate a valid Swagger or OpenAPI version field
giser@2011的博客
07-21 1893
swagger-ui.html报错， The provided definition does not specify a valid version field. Please indicate a valid Swagger or OpenAPI version field. Supported version fields are swagger: "2.0" and those that match openapi: 3.0.n (for example, openapi: 3.0.0).
springboot 集成 swagger2 报错 Please indicate a valid Swagger or OpenAPI version field.
qq_34595792的博客
10-12 6322
由于是maven+springcloud 多模块项目，使用了gateway网关，并且添加了过滤器，验证token，需要在gateway中添加白名单：/admin/swagger-ui.html,/admin/swagger-resources/,/admin/webjars/,/admin/v2/**，重启即可通过gateway进行访问 ...
swagger：遇到 Unable to render this definition错误(for example, openapi: 3.0.0).
qq_40853517的博客
06-28 9349
今天改了代码 后，遇到以下错误 显示 ： Unable to render this definition The provided definition does not specify a valid version field. Please indicate a valid Swagger or OpenAPI version field. Supported version fields are swagger: "2.0" and those that match openapi: 3.0.n
fastapi swagger
05-20
FastAPI 是一个现代化的 Web 框架，它基于 Python 3.6+，并使用了一些最新的技术，如 type hints、asyncio 和 Pydantic。FastAPI 可以让你快速地构建高性能的 Web 应用程序和 API。 Swagger 是一种 API 文档和交互式测试工具，它可以帮助开发者快速地了解和测试 API。FastAPI 集成了 Swagger UI，使开发者可以通过浏览器轻松地查看和测试 API。 在 FastAPI 中，只需要使用少量的代码就可以生成 Swagger 文档。你可以使用 FastAPI 内置的 `FastAPIOpenAPI` 和 `FastAPISwaggerUI` 类来集成 Swagger UI，代码示例如下： ```python from fastapi import FastAPI from fastapi.openapi.utils import get_openapi from fastapi.responses import HTMLResponse from fastapi.staticfiles import StaticFiles from fastapi.templating import Jinja2Templates from fastapi import FastAPI from fastapi.openapi.utils import get_openapi from fastapi.responses import JSONResponse, HTMLResponse from fastapi import FastAPI from fastapi.openapi.utils import get_openapi from fastapi.responses import JSONResponse, HTMLResponse from fastapi import FastAPI from fastapi.openapi.utils import get_openapi from fastapi.responses import JSONResponse, HTMLResponse from fastapi import FastAPI from fastapi.openapi.utils import get_openapi from fastapi.responses import JSONResponse, HTMLResponse app = FastAPI() # 静态文件 app.mount("/static", StaticFiles(directory="static"), name="static") # 模板文件 templates = Jinja2Templates(directory="templates") # 路由 @app.get("/", response_class=HTMLResponse) async def home(request: Request): return templates.TemplateResponse("index.html", {"request": request, "title": "FastAPI"}) @app.get("/docs", response_class=HTMLResponse) async def read_docs(request: Request): return templates.TemplateResponse("docs.html", {"request": request, "title": "API 文档"}) @app.get("/openapi.json", response_class=JSONResponse) async def get_open_api_endpoint(): return JSONResponse(get_openapi(title="FastAPI", version="0.1.0", app=app)) # 启动 FastAPI if __name__ == "__main__": uvicorn.run(app, host="0.0.0.0", port=8000) ``` 在上面的代码中，我们创建了一个 `FastAPI` 实例，并使用 `app.mount` 方法来加载静态文件。然后，我们使用 `Jinja2Templates` 类来加载模板文件。接下来，我们定义了三个路由：`/`、`/docs` 和 `/openapi.json`。其中，`/` 和 `/docs` 路由返回 HTML 页面，`/openapi.json` 路由返回 Swagger 文档。 最后，我们使用 `uvicorn` 模块来启动 FastAPI。启动后，我们可以通过浏览器访问 `http://localhost:8000/docs` 来查看 Swagger UI。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

hzw0510

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值