swagger 相关问题

Swagger是一个框架实现,用于基于Open API规范描述,生成,使用和可视化RESTful Web服务

REST API 中有 2 个强制标头有意义吗?

上下文: 我正在构建一个 REST API,其中我们的所有端点都受到保护。 API 的使用者是一家酒店。每家酒店都有一个唯一的 API 密钥。酒店有客人。每位客人都有一个唯一的 ID ...

回答 1 投票 0

SwaggerSchema 不适用于我自己的对象

我正在使用 ASP.NET 创建 Web API。为了向用户公开我的数据库模型,我创建了数据模板对象,以便我可以显示/隐藏 swagger 架构中的属性。 问题是我...

回答 2 投票 0

如何使用 Swagger 显示骆驼休息参数对象列表

如何让camel-swagger-java扫描camel Rest api路由并表示rest端点参数,该参数是pojo对象的列表,其中这些pojo具有json属性? 当尝试我们...

回答 3 投票 0

如何使用 swagger 查询定义嵌套数组?

我的方法是POST,但是它是通过查询参数来获取数据的。我无法更改按正文检索数据的方法的逻辑。 是否可以在查询中发送嵌套数组(不是在http正文中,因为它...

回答 1 投票 0

swagger ui 无法通过 micronaut 多模块项目 gradle build 访问

我有以下项目结构 项目产品和API网关共享公共项目。由于在父项目 settings.Gradle 中,我已包含该项目,如下所示 rootProject.na...

回答 4 投票 0

Swagger/openapi 将 @Schema(description) 添加到每个枚举值

我正在使用 Swagger/OpenApi V3 注释创建应用程序的 API 描述,从以下依赖项导入: org.springdoc ...

回答 1 投票 0

手动添加 Swagger 文档不会在响应部分显示示例值

我有一个带有一些端点的简单 django Rest API 项目。我已经安装了 swagger API 文档来查看和测试 API。如您所知,API 依赖于模型和序列化器

回答 1 投票 0

APEX Rest API - Swagger

我对整个 APEX 服务插件有点陌生,但我想知道 Salesforce 是否对 Swagger 或任何类似的 REST 描述语言、我在 ... 中创建的 REST api 具有本机支持

回答 2 投票 0

使用 Angular 应用程序配置 SQL Server 数据库连接字符串

我正在尝试通过让我自己与 10 多人一起完成的一个大项目重新焕发活力来练习我的全栈技能。我记得在某个时候我了解到有 appsettings.json 和 apps...

回答 1 投票 0

带有 OdataQueryOptions 的 ASP.NET Core Web API 方法未在 swagger 文档中正确显示

我有一个 ASP.NET Core 3.1 Web API,使用 Swashbuckle.AspNetCore 5.3.3,并使用非 edm 方法实现 OData。 公共无效ConfigureServices(IServiceCollection服务) { 服务。

回答 1 投票 0

带有 OdataQueryOptions 的 WebApi 方法未在 swagger 文档中正确显示

rest API 项目: 使用: dotnet 核心 3.1,swashbuckle.AspNetCore 5.3.3。 使用非 Edm 方法实施 Odata。 公共无效ConfigureServices(IServiceCollection服务) { 服务。

回答 1 投票 0

JaxrsOpenApiContextBuilder 不支持 jakarta

我在我的项目中使用以下依赖项:- io.swagger.core.v3 swagger-jaxrs2 我在我的项目中使用以下依赖项:- <dependency> <groupId>io.swagger.core.v3</groupId> <artifactId>swagger-jaxrs2</artifactId> <version>2.2.22</version> </dependency> 下面是我尝试生成 swagger 资源的地方:- OpenAPI oas = new OpenAPI(); Info info = new Info(); info.title("Swagger catalog-db-adapter bootstrap code"); info.setVersion("1.0.2"); SwaggerConfiguration oasConfig = new SwaggerConfiguration().openAPI(oas).prettyPrint(true) .resourcePackages(Stream.of("org.onap.so.adapters.catalogdb.rest").collect(Collectors.toSet())); try { new JaxrsOpenApiContextBuilder().application(this).openApiConfiguration(oasConfig).buildContext(true); } catch (OpenApiConfigurationException e) { throw new RuntimeException(e.getMessage(), e); } 但是我收到一个错误,因为 JaxrsOpenApiContextBuilder 仍然支持 javax 而不是 jakarta。除了我正在使用的之外,我们是否还有任何依赖项包含 jakarta 而不是 javax 的导入 使用为 Jakarta EE 构建的并行 Swagger 工件集。 引用维基: 注意:Jakarta 命名空间支持(自版本 2.1.7 起) 自版本 2.1.7 起,Swagger Core 还支持 Jakarta 命名空间,并具有一组带有 -jakarta 后缀的并行工件,提供与“标准”javax 命名空间相同的功能。 虽然本文档中描述的行为对于命名空间、工件 ID、JEE / Jakarta EE 版本和提到的 Jackson 版本是相同的,但均引用 javax 命名空间。 如果您使用 jakarta 命名空间: 当您读取以下形式的工件 ID 时:swagger-*(例如 swagger-core),请将其替换为 swagger--jakarta(例如 swagger-core-jakarta) 当您在包名称中读取 javax. 时,请将其替换为 jakarta(例如 jakarta.ws.rs.GET) 当示例中提供了 JEE / Jakarta EE 依赖项时,请将其版本替换为 Jakarta EE 9 版本。 当示例中提供 Jackson 依赖项时,请为支持它的工件添加 jakarta 分类器。请参阅 Jackson 发行说明 Jakarta 名称空间 Swagger Core 工件需要 Jackson 2.12+

回答 1 投票 0

如何在 OpenAPI (Swagger) 中定义一个可以是字符串或 null 的属性?

我有 JSON 架构文件,其中属性之一定义为字符串或 null: “类型”:[“字符串”,“空”] 当转换为 YAML(与 OpenAPI/Swagger 一起使用)时,它将变为: 类型: - 'n...

回答 1 投票 0

查询参数中传递的聚合对象的 Swagger 描述不起作用

我正在 dotnet 中开发 GET API,我一直在尝试记录传递的查询参数,该参数是结果分页的聚合对象(页面大小和页码)。 评论/

回答 1 投票 0

如何解决以下项目中的 ##[错误]Dotnet 命令失败并出现非零退出代码:[ '' ] 错误?

关于如何解决下面这个管道错误以构建和部署 Web API 有什么建议吗? 它在 ${{parameters.DocumentName }} 的生成 OpenAPI 定义步骤上失败,并出现错误...

回答 1 投票 0

如何使用 swagger OpenAPI 注释为字段设置描述

为了改进我们的 api 文档,我想向响应正文的字段添加描述 作为示例,请参阅此处的默认 petstore 规范:https://editor.swagger.io/ 在帖子/宠物中 在宠物中

回答 2 投票 0

ASP.NET Core 8.0 OpenAPI Swagger 中的某些端点没有身份验证

我正在开发 ASP.NET Core 8.0 Web API。您能告诉我为什么某些端点在 Swagger UI 中没有挂锁图标吗? 例如我的 ASP.NET localhost: localhost ASP.NET swagger。 另一方面...

回答 1 投票 0

如何在 Springdoc 中设置 header 的编码

我对 Swagger 自动生成的 Swagger 文档有疑问。问题是,尽管我已将项目设置为 UTF-8,但身份验证标头仍然以 ISO-8859-1 编码,w...

回答 1 投票 0

将 Swagger Basic AUTH 添加到 Spring Boot 应用程序

要求: 使用 Springfox 的 Spring Boot 应用程序 向 Swagger 添加 BASIC 身份验证 传递所有其他请求 代码:已实施 @EnableWebSecurity @配置 公共类 SecurityConfig

回答 4 投票 0

根据 Swagger API 架构进行 API 请求验证 (openapi 3.0.2)

是否有任何 java/python/javascript 库可以根据 openapi 3.0.2 验证 API 请求/有效负载 我查了很多图书馆,但没能找到正确的图书馆。 有一个问题...

回答 1 投票 0

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