openapi 相关问题

OpenAPI规范(最初称为Swagger规范)是用于描述,生成,使用和可视化RESTful Web服务的机器可读接口文件的规范。

基于控制器的 API 中 .NET 9 枚举类型的问题

我在使用 .NET 9 时遇到问题。 特别是,此类代表我遇到问题的端点的输入。 公共类 RequirementForAdd { 公共字符串属性名称 { ge...

回答 1 投票 0

使用 Stoplight Spectral CLI 为应用程序/问题+json 自定义规则

我正在尝试根据可以在此处找到的未知错误格式制定自定义规则。以这个开放API文档为例: openapi 生成的.yaml 开放API:3.0.3 信息: 标题:API

回答 1 投票 0

Spring 反序列化列表<Resource>

我有一个带有 openApi 的 springboot 项目用于生成规范,我尝试创建一个接收许多文件的端点,但我有一个 spring 错误。 JSON 解析错误:无法反序列化类型的值...

回答 1 投票 0

在FastAPI自动文档中插入本地图片

简介 当您使用 FastAPI 创建 API 时,FastAPI 可以自动生成您的文档。 我正在尝试在我的一个端点的描述(降价)中插入图像,但我不能......

回答 2 投票 0

每个端点(URL)是否需要独立的OpenAPI客户端?

TL;博士: 本质上如标题所示,我是否需要为每个端点 URL 安装独立的 OpenAPI 客户端? 细节: 我正在使用 OpenAPI 生成器创建 Python 客户端,目的是接收...

回答 1 投票 0

OpenAPI:定义具有一个必填字段和互斥可选字段的 JSON 模式

我正在为具有特定负载结构的端点创建 OpenAPI 描述: 1 个字段为必填字段 两个附加字段是可选的 只能出现一个可选字段...

回答 2 投票 0

如何生成 JSON 或 YAML 格式的 Swagger v3 文档?

我正在使用 Swagger v3 注释来记录我的控制器路由,例如: @OpenAPIDefinition(信息 = @Info(标题 = "招摇弹簧", 描述=“测试大摇大摆...

回答 1 投票 0

在 Spring Boot 项目的实现中强制执行 OpenAPI 规范

我正在开发一个 Spring Boot (WebFlux) 项目。我已使用 OpenAPI YAML 清单定义了 API 规范,作为项目的一部分。 开放API:3.0.0 信息: 标题:API 示例 描述:xxxxx 路径: ...

回答 1 投票 0

在尝试更改标头身份验证密钥名称后,我在使用 Swagger UI 进行身份验证时遇到一些问题

我在使用 Swagger UI 进行身份验证时遇到一些问题。 我修改了 lexik_jwt_authentication.yaml 文件,从授权标头中提取名为“X-Authoriza...

回答 1 投票 0

OpenAPI Generator 不生成多部分/表单数据的函数

我有一个使用 DRF-Spectaulous 生成的 OpenAPI 架构。重要的部分是: ... 修补: 操作 ID:病人_部分_更新 参数: - 在:路径 不...

回答 1 投票 0

OpenAPI 生成器向 ApiClient 构造函数添加/生成注释

我使用最新的OpenAPI生成器6.2.1(https://github.com/OpenAPITools/openapi-generator)使用resttemplate库生成ApiClient,效果非常好。 在我的申请中我有...

回答 2 投票 0

Apache Camel Rest DSL OpenAPI 生成器

基于示例,我在 Apache Camel Spring Boot 项目中创建了以下 REST 端点并发布了 OpenAPI 规范: 根据示例,我在 Apache Camel Spring Boot 项目中创建了以下 REST 端点并发布了 OpenAPI 规范: <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://camel.apache.org/schema/spring http://camel.apache.org/schema/spring/camel-spring.xsd"> <camelContext xmlns="http://camel.apache.org/schema/spring"> <restConfiguration component="servlet" apiContextPath="/api-docs"> </restConfiguration> <rest path="/say"> <get path="/hello"> <to uri="direct:hello"/> </get> <get path="/bye" consumes="application/json"> <to uri="direct:bye"/> </get> <post path="/bye"> <to uri="mock:update"/> </post> </rest> </camelContext> </beans> 目前,当我访问以下网址:/api/api-docs时,我收到以下响应: "openapi" : "3.0.0" 从中可以清楚地看出 OpenAPI 规范正在版本 3.0 中生成 我正在使用Apache Camel 4.9.0-SNAPSHOT。 是否可以配置Camel生成2.0版本的OpenAPI规范? 不,它不像詹姆斯在上面的评论中所写的那样

回答 1 投票 0

针对不支持的操作的 HTTP 服务器行为和 REST API 规范

我有一些REST API的规范,并且我也在开发相应API的一些实现。 问题出现了,我的实现应该为操作返回什么 HTTP 状态代码...

回答 1 投票 0

通过 Terraform 部署基于 OpenAPI 的 API 网关?

我获得了 SwaggerHub 上托管的 OpenAPI 3.0.1 定义的链接,并被告知要部署它。在 Terraform 方面,我看到太多资源让我困惑,我不知道该使用哪一个......

回答 2 投票 0

如何在 OpenAPI 中弃用整个 API?

我想找到一种方法将 API 标记为已弃用。 这是一种可能的情况:开发了 GraphQL API,而不是 REST API,但为了顺利停用旧的 REST API,我想...

回答 1 投票 0

如何使用 OpenAPI 和 Scalar API 文档对控制器进行分组

我有一个 ASP.NET Core 9 Web API 应用程序。默认情况下,.NET9 不再使用 Swashbuckle。为了生成 API 文档,我使用 Microsoft OpenAPI 文档和 Scalar。 效果很好。我不...

回答 1 投票 0

Spring Security 6 - OpenApi 返回 HTTP 错误 403 *已修复

我刚刚开始学习Spring Security。我可以使用 Postman 访问它,但无法使用 OpenApi 访问它。可能是什么问题?在我更新并添加安全性之前它就可以工作。 春季启动

回答 1 投票 0

springdoc-openapi v2.6.0 未公开 Swagger-UI

我正在使用以下版本: spring-boot-starter-parent:3.3.3 java.版本:21 spring-cloud-版本:2023.0.3 springdoc-openapi-starter-webmvc-ui:2.6.0 当我运行应用程序时...

回答 1 投票 0

Zed 攻击代理 (ZAP) - OpenAPI 扫描 - 对 API 端点的错误请求 [/JSON/openapi/view/results/] - ApiException:BAD_VIEW(结果)

这是我的 bash 脚本中启动 openapi 扫描的请求: BASE_ZAP_URL="http://localhost:8080/JSON" OPENAPI_URL="${BASE_ZAP_URL}/openapi/action/importFile/"

回答 1 投票 0

有什么方法可以根据所选服务器更改 OpenAPI 规范中的值吗?

在我的 OpenAPI 描述中,我定义了多个服务器,如下所示: 服务器: - 网址:/stuff/api/v1 描述:生产 - 网址:/api/v1 描述:测试 我们有一台托管 Swa 的服务器...

回答 1 投票 0

© www.soinside.com 2019 - 2024. All rights reserved.