swagger-2.0相关内容

模型表单-YAML文件中使用Swagger 2.0的数据体请求

我使用的是swagger 2.0,我有一个终结点,它使用表单数据作为请求的有效负载,我在几个地方使用相同的表单数据主体请求,我不想一次又一次地编写它(复制它),我不知道如何在我的YAML文件中对其建模(当对象作为请求主体的一部分作为有效负载时,我知道如何对其建模)。 这是我尝试建模的表单数据有效负载: 我查看了Swagger的文档:https://swagger.io/docs/spe ..
发布时间:2022-08-11 16:45:16 其他开发

Spring Boot-Swagger文档不起作用

我有一个使用Spring Boot构建的rest API项目,我想记录我的所有端点。我已经实现了Swagger,并且成功了,但最近我的项目不再运行,配置与创建项目和Swagger工作时相同。 尝试运行项目时出现此错误: WARN 17868 --- [ restartedMain] ConfigServletWebServerApplicationContext : Exceptio ..
发布时间:2022-04-16 20:02:55 Java开发

大摇大摆地接受Google OAuth 2.0授权

默认情况下,swagger将access_code传递给标头。是否可以通过id_token? 我正在用swagger.yaml版本记录我的NodeJS睡觉接口2.0 推荐答案 是,这是可能的,尽管这不是一个好主意,因为mentioned by @DalmTo。 您需要将x-tokenName: id_token添加到API定义中的Google OAuth安全定义。 s ..
发布时间:2022-02-24 19:56:48 其他开发

使用Swagger-UI启用Json编辑器

如何通过以下GitHub(https://github.com/jensoleg/swagger-ui)使用Json编辑器? 要为请求正文启用JSON编辑器,需要使用哪些代码? 尝试更改我的代码,但对我无效。如有任何帮助,我们将不胜感激。 Swagger UI 3.x和4.x不支持推荐答案 JSON表单编辑器。有一个existing feature request。 ..
发布时间:2022-02-24 19:49:57 其他开发

如何在 swagger 规范中表示十进制浮点?

我想在我的 api 文档中用 2 位表示小数,用 1 位表示小数.我正在使用 swagger 2.0,规范中是否有内置定义类型或任何其他“圆形"参数,或者我唯一的选择是使用“x-"扩展名? 解决方案 OpenAPI (fka Swagger) 规范使用 JSON Schema 来描述数据类型. 如果参数作为数字传递,您可以尝试使用 this Q& 中建议的 multipleOf一个: ..
发布时间:2022-01-22 18:32:51 其他开发

要求数组在 Swagger Schema 对象定义中至少包含一个元素

我的 swagger.yaml 中有这样的架构对象定义: 用户:类型:对象特性:用户名:类型:字符串描述:用户名颜色:类型:数组项目: {类型:字符串,枚举:[“红色"、“蓝色"、“绿色"]}描述:用户必须关联一种或多种颜色必需的:- 用户名- 颜色 但是,生成的服务器仍然很乐意接受使用此架构对象作为不包含任何 colors 字段的必需主体参数的 POST 请求. 我能否以 color ..
发布时间:2022-01-22 18:29:35 其他开发

Swagger:不允许的其他属性:allOf

我正在尝试通过使用 allOf 来找出这种招摇的 API 继承的东西.这是我招摇的 yaml 文件. 招摇:'2.0'信息:标题:测试API版本:'1'基本路径:/api/v1方案:- https产生:- 应用程序/json路径:/用户:得到:摘要:用户集合标签:- 用户回复:200:描述:用户列表架构:$ref:“#/定义/用户"500:$ref: "#/responses/BadReques ..
发布时间:2022-01-22 18:27:57 其他开发

如何定义HashMap<String、List<Object>>swagger yml 中的属性?

我正在使用 swagger 在 Java 和 Type 脚本中生成类.我在使用对象列表作为值定义地图属性时遇到问题.我尝试定义如下: DataMap类型:对象附加属性:#type: array -- 这个配置不起作用.$ref: '#/定义/数据' 上面的yml定义在java中生成如下代码: 类 DataMap 扩展 HashMap;{} 如何配置 yml 以生成带有数据列表的密钥?类似 ..
发布时间:2022-01-22 18:26:08 Java开发

使用 Springfox-Swagger2 在 Swagger UI 中自定义请求标头描述

我在我的 Spring Boot 应用程序中使用 Springfox Swagger2 2.4.0 版、Springfox Swagger UI 2.4.0 版和 Swagger Annotations 1.5.0 版. 这里的问题是,我能够为我的控制器的 API 生成 swagger UI,并且我能够对其进行测试.但我无法为我的请求标头指定请求标头描述.我正在使用 @RequestHead ..
发布时间:2022-01-22 18:18:41 其他开发

500 内部服务器错误:[{“错误":[“解析值时遇到意外字符:%.路径'',第 0 行,位置 0."]}]

我正在使用 RestTemplate 调用 AutoTask API.但是,我收到一条错误消息: 500 Internal Server Error: [{"errors":[""Unexpected character met while paring value: %.路径 '',第 0 行,位置 0."]}] API 调用的 Swagger UI 截图(成功) 控制台输出(错误) ..

Swagger:支持可选路线

我有一个带有可选参数的路由: [Route("{categoryId?}")]公共 HttpResponseMessage 获取(int?categoryId=null) 但是,当我没有为 categoryId 提供值时,调用会在请求本身中包含 {categoryId?}... http://myhost/api/%7BcategoryId%7D 解决方案 Swagger 不支持可选路 ..
发布时间:2022-01-22 18:08:12 其他开发

如何在 OpenAPI (Swagger) 中将 $ref 属性声明为只读?

我正在尝试在此示例中为“House"添加一个只读字段.房子是另一个我想只读的模型. 在此示例中,Dogs 数组可以设置为 readOnly 而不会出错,但是当我将 House 的单个定义设置为 readOnly 时,我收到以下警告在 Swagger 编辑器中: 同级值不允许与 $refs 一起使用 我知道这是因为模型中的所有内容都在这里继承.那么如何定义 write API 调用 ..
发布时间:2022-01-22 18:06:29 其他开发

不允许的附加属性:可为空的招摇

我正在使用带有 node.js express 4.12.3 和 mysql db 的 swagger 2.0. 我创建了以下架构 - 国家:类型:“对象"特性:ID:类型:“整数"只读:真描述:“国家 ID"国家:类型:“字符串"描述:“国家名称"created_at:类型:“字符串"只读:真格式:“日期时间"描述:“国家记录创建日期"已删除_at:类型:“字符串"格式:“日期时间"描 ..
发布时间:2022-01-22 18:05:32 其他开发

如何在 Swagger 中定义角色/权限安全性

在我的 API 文档中,我想为每个 API 端点定义必要的安全性.该项目已定义角色和权限,以确定哪些用户可以访问 API.Swagger 中记录此信息的最佳方式是什么?是否有关于如何显示此详细信息的最佳做法或建议? 这是我尝试使用 securityDefinitions 和角色的自定义变量,但是当我通过 swagger2markup 或使用 swagger-ui 运行它时,该信息(x-rol ..
发布时间:2022-01-22 18:00:43 其他开发