问题标签 [swagger-3.0]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
0 回答
30 浏览

spring-boot - 如何使用 swagger 3 spring boot 记录 Spring Data 休息端点

我有一个包含弹簧数据休息的弹簧启动应用程序。我想用 swagger 3 记录弹簧数据休息端点。我已经完成了以下实现。

但是当我打开 swagger ui 时。spring 数据休息端点未显示在 ui 中。

0 投票
0 回答
722 浏览

swagger-ui - Java Spring Boot OpenApi 3 - 如何为 RequestBody 添加@Schema?

}

2.

}

以上代码段 1.工作正常。在 Swagger UI 中,我可以看到带有示例值的 RequestBody,我可以在其中执行它。

但是对于片段 2。当我尝试继承(即 oneOf、allOf 或 anyOf)时,此架构不起作用。只有 BasicBook 属性进入(Swagger UI)RequestBody 的示例值。

我也试过@Parameter。这是代码

3.

}

片段 3.也没有给出想要的结果。

如何在 RequestBody 中使用 oneOf、allOf 或 anyOf。

0 投票
1 回答
100 浏览

java - 尝试使用 swagger 使用文件(多部分)生成带有 json(应用程序/json)数据的存根(java 文件)

尝试提交带有多个附件(文件)的表单,无论它是正确的方法还是我不知道我是否使用 multipart/form-data 无法提交 json 数据。

路径:/request/create:post:tags:-请求服务API摘要:请求媒体文件访问安全性:[] operationId:createMediaRequest参数:-名称:userId in:标头描述:用户登录ID:true schema:类型:字符串 - 名称:xt-trace-id in:标头描述:请求跟踪 id 要求:true 架构:类型:字符串

和附件是

0 投票
0 回答
64 浏览

laravel - Lumen 8.0 with swagger 8.* 在生成文档时出错

我正在使用最新的流明版本8.0swagger 8.*. 在本地它工作正常,但是当我尝试 heroku(它的部署位置)时,它每次都会出现这个错误

在此处输入图像描述

我尝试在 env 文件中添加所有常量、路径,但仍然出现此错误,没有希望,请给点建议?

0 投票
0 回答
27 浏览

spring - Eureka - Swagger 定义的分类

我想在 Eureka Gateway 公开的 Swagger UI(使用 Swagger3/OpenApi3)中创建自己的类别而不是服务名称。

我需要将一个服务定义拆分为几个更小的服务定义,并将其余的(服务)聚合成一个大张旗鼓的定义。

我尝试创建List<GroupedOpenApi>但没有成功。

0 投票
0 回答
12 浏览

swagger - Micornaut:是否可以使用不同的端点在 Swagger OpenApi 中自定义“探索”栏?

我想在我的 Micronaut 项目中使用自定义端点以及ExploreSwagger 规范 (v. 3.0.1) 栏中的自定义路径。我已经使用securityintercept-url-map字段配置了我的 application.yml 服务来定义(如我所想的)将在Explorebar 中使用的路径。我发现,除了从 from 开始的端点之外的所有端点swagger/都无法运行。我越来越:

我记得也在 swaggeryml文件中修改它,并使用正确的html文件路径。唯一的区别是swaggerpatternintercept-url-map哪里停止工作的名称。某人是否有类似的问题,或者您有任何想法如何定制它?

0 投票
0 回答
50 浏览

spring-boot - 使用 Swagger 3 和 Springboot 启用 JWT 授权

我想在使用 SpringBoot 和 Spring MVC 实现的 Swagger 3.0 Api 中启用 JWT 授权。我不想使用 Swagger 2.0,从我看到的 Springfox 仅与 Swagger 2.0 兼容

我到底可以使用什么以及如何使用?

0 投票
0 回答
22 浏览

java - 省略基于 Http 方法类型 POST 和 PUT 的 OpenAPI 文档的参数

对于我的 spring boot 应用程序,我有一个 User 类:

我有一个带有 PUT 和 POST 方法的控制器:

当我使用 OpenAPI 3 生成文档时,所有四个参数都显示在为两个 API 生成的有效负载中。但我想根据调用的方法隐藏参数。

对于 POST,我希望正文为:

对于 PUT,我希望身体为:

@Schemaannotation 仅提供基于 READ/WRITE 设置访问模式。这里两种访问模式都是 WRITE 但不同的是 Http 方法。谁能告诉我如何使它成为可能。我如何在类中注释我的属性,User以便基于 HttpMethod 隐藏和显示它们。

0 投票
1 回答
156 浏览

scala - Swagger 3 使用注释记录地图

我在 Scala 中有一个响应模型:

我如何使用注释@Schema 或 @ArraySchema 或类似的东西来记录这一点?

没有 yml 文件,所有字段仅使用 Schema|ArraySchema 进行描述,如下所示:

0 投票
1 回答
399 浏览

node.js - 在带有 openapi 3.0 的 Swagger 中,没有显示我的嵌套对象方案

我在一个带有 express 框架的 nodeJS 项目中工作,我正在使用 swagger-jsdoc 和 swagger-ui-express,我也在 yaml 文件中编写我的配置。我想记录我的服务,但是当我尝试显示嵌套对象时遇到了一些问题。简单地说,当我展开嵌套对象树时,我什么也看不到。请帮忙。