Swagger-使用不同端口的方案 HTTP 和 HTTPS
如何指定具有不同端口的多个架构?具体来说，我想在端口 81 上使用 HTTP，在端口 444 上使用 HTTPS. 招摇:'2.0'信息:版本:1.0.0标题:网关 API描述:网关访问服务器的 API(http 81 端口，https 444 端口)方案:- http- https主机:gateway.example.com:81基路径:/1.0路径: 解决方案 这在 OpenAPI 3.
..
swagger-2.0相关内容
招摇限制响应的错误代码
我正在处理一个 swagger 2.0 文件，我想在其中指定响应中的错误代码只能是 USERNAME_VALIDATION_FAILED 或 EMAIL_VALIDATION_FAILED.这是由于 swaggerfile 的 swagger-ui 视图，其中每个响应错误都可以在错误代码枚举中定义 20 个错误代码.如何限制特定响应的可能错误代码? 在我的 swaggerfile 中有请求
..
奇怪的“无法解析引用:未定义未找到"Swagger UI 3 中的消息
将 Alfresco 的 REST API Explorer 从 Swagger UI 2 迁移到 Swagger UI 3 时(3.38.0)，单个 API 定义在以下位置引发了两个 无法解析引用:未定义未找到错误: paths./search.post.parameters.0.schema.properties.pivots.items.properties.pivots.items.$r
..
要求数组在 Swagger 架构对象定义中至少包含一个元素
我的 swagger.yaml 中有这样的架构对象定义: 用户:类型:对象特性:用户名:类型:字符串描述:用户名颜色:类型:数组项目: {类型:字符串，枚举:[“红色"，“蓝色"，“绿色"]}描述:用户必须关联一种或多种颜色必需的:- 用户名- 颜色 然而，生成的服务器仍然愉快地接受使用这个架构对象作为不包含任何colors字段的请求体参数的POST请求. 我能否以一种方式配置 Swag
..
一个 Swagger 文件中的多个 API 文档
是否可以有多个(以某种方式分开的)REST API 文档，但只能在一个 swagger yaml 文件中? 或者 swagger yaml 可以只包含一个 API 文档吗? 因为我有 2 个由我开发的 REST API，并且我想要一个通用的 swagger ui 而不是两个，我可以使用像 Tyk 这样的网关来管理. 解决方案 你可以用 swagger.io 标签 例如在
..
Swagger YAML 声明中的子路径
我正在尝试通过在 Swagger YAML 中描述来创建 REST 服务. 服务有三个路径: /版本 /partners/{partnerId}/users/{userId}/sessions /partners/{partnerId}/books/{bookId}/ 我当前描述这些路径的 YAML 文件如下所示: 招摇:'2.0'信息:版本:'0.0.1'标题:测试 AP
..
swagger:路径参数中的文件路径
这是我的api要求 GET http://localhost:8080/filePath/{path} 例如: curl http://localhost:8080/filePath/home/users/user/one.txt 这里是yaml配置: 参数:- 名称:路径在:路径描述:待办事项描述类型:字符串要求:真实 但是我收到了 404 错误.如何在路径参数中使用文件路径?
..
使用 swagger 定义 API:在参数中使用 JSON 的 GET 调用
我正在尝试创建一个合适的 REST API，并使用 Swagger (2.0) 对其进行记录. 所以，我有一个 API 调用，它是一个查询，即它不做任何更改，也不创建任何内容(幂等且安全).但它需要传入一个复杂的 JSON 参数(项目列表、2 或 3 组地址等).所以我正在做一个带有 URL 编码 JSON 参数的 GET.这似乎是正确的做法. 出于这个原因，我经常看到这样的 API，
..
如何根据现有的邮递员集合生成 swagger?
我正在开发 REST API.在开发过程中，我使用 postman(chrome 扩展)来使用和记录我的 API.这是一个很棒的工具，我的大部分 API 端点都在其中.但是，当我们接近发布时，我想用 swagger 来记录这个 API，我该怎么做?有没有办法可以根据邮递员导出生成 swagger? 解决方案 有人发布了此链接(并删除了它?):http://restunited.com/
..
使用 Swagger 描述多范围参数
我想在 Swagger 2.0 中描述一个定义如下的参数: 参数在区间内取有效值:-20 或 0 参数无效，如果:-10 ≤ 参数 ≤ 0 这意味着它有两个有效间隔，因此要定义两个最大值和最小值.Swagger 规范是否支持这种定义? 解决方案 这无法在 OpenAPI/Swagger 2.0 中描述，但可以在 OpenAPI 3.x 中使用 oneOf 进行描述.
..
如何在 Swagger 中引用包含响应示例的外部 JSON 文件?
在我的 Swagger 规范文件中，我想返回示例响应，为此我可以在响应中添加 examples.但这使我的规范文件非常大且容易出错.有没有办法引用包含示例对象的 JSON 的文件? 我尝试过类似下面的方法，但似乎不起作用. 获取:标签:- 企业摘要:获取应税实体详细信息描述: ''操作 ID:getTaxableEntities产生:- 应用程序/json参数:- 名称:business_
..
如何在 swagger 规范中表示十进制浮点数?
我想在我的 api 文档中用 2 位表示小数，用 1 位表示小数.我正在使用 swagger 2.0，规范中是否有内置定义的类型或任何其他“圆形"参数，或者我唯一的选择是使用“x-"扩展名? 解决方案 OpenAPI (fka Swagger) 规范使用 JSON Schema 来描述数据类型. 如果参数以数字形式传递，您可以按照本问答中的建议尝试使用 multipleOf一个:
..
如何在 OpenAPI (Swagger) 中指定多个主机?
现在我的 OpenAPI 2.0 YAML 文件只有一个主机 URL: 主机:petstore.test.com基本路径:/ 我可以像这样使用多个主机吗? host1:petstore.test.com主机 2:petstore1.test.com主机 3:petstore2.dev.com 解决方案 OpenAPI 2.0 (Swagger 2.0) 仅支持具有多种方案(HTTP/HT
..
Swagger/Open API 2.0 我可以声明一个通用的响应头吗?
是否可以声明一个自定义响应标头，该标头将出现在所有响应中，而无需在每个响应结构中复制它? 解决方案 根据 编写 OpenAPI (Swagger) 规范教程 – 第 5 部分 – 高级输入和输出建模 答案是否定的.这也是我从 2.0 规范中了解到的. 投票/评论 结构改进:增强标头处理 · 问题 #690 · OAI/OpenAPI-规格.
..
Swagger 编辑器显示“架构错误:不应具有其他属性"；路径参数错误
我正在使用 http://editor.swagger.io 来设计 API，但出现错误我不知道如何解决: 路径中的架构错误['/employees/{employeeId}/roles'].get.parameters[0]不应该有额外的属性附加属性:类型、格式、名称、输入、描述跳到第 24 行 我以类似的方式定义了其他端点，并且没有收到此错误.我想知道我是否有缩进或未闭合引号的问题，但似乎
..
从 springfox swagger2 迁移到 springdoc openapi
https://www.dariawan.com/tutorials/spring/documenting-spring-boot-rest-api-springdoc-openapi-3/ 努力遵循这些 我如何处理像这样的注释 @ApiModel(value = "响应容器")@ApiModelProperty(value = "库存响应", required = true) 解
..
为什么从 Swagger UI 发送的请求中缺少 Authorization 标头?
我想向我的 Node.js API 添加一个文档，为此我有一个 YAML 文件，我在其中放置了我的定义，swagger 文档位于 localhost:5000/api-doc 并且工作正常. 现在我必须添加 Bearer 授权但 Swagger 定义如下: swagger: “2.0";信息:版本:1.0.0标题:我的 API 文档描述:>我的 API 文档主机:本地主机:5000基路径:
..
如何指定属性可以为空或使用 swagger 引用
如何将属性指定为 null 或引用? 讨论了如何使用 jsonschema 将属性指定为 null 或引用. 我希望用 swagger 做同样的事情. 总结一下上面的答案，使用 jsonschema，可以这样做: {“定义":{“福":{# 一些复杂的对象}},“类型":“对象"，“特性": {“富":{“一个":[{"$ref": "#/definitions/Foo"},{“类型
..
Swagger UI 中的多级(嵌套)标记
我最近刚刚开始研究 Swagger 2.0 API.我正在寻找一些方法来组织 API 文档. 目前我使用 @Api(tags = {“Heading1"}) Java 注释来标记每个 API.生成的文档看起来像 任务--------->标题1-------->Desc1--------->Desc2---------->标题2--------->Desc3--------->Desc4
..
使用 $ref 时忽略 Swagger 架构属性 - 为什么?
我正在尝试为一个时间间隔构建一个 Swagger 模型，使用一个简单的字符串来存储时间(我知道还有日期时间): 定义:时间:类型:字符串描述:时间采用 24 小时格式“hh:mm".时间间隔:类型:对象特性:下限:$ref: "#/定义/时间"描述:时间间隔的下限.默认值:“00:00"上界:$ref: "#/定义/时间"描述:时间间隔的上限.默认值:“24:00" 由于某种原因，生成的 HT
..