大摇大摆地发布一个 json 正文
我想用 Swagger 发布一个 json 正文，如下所示: curl -H "Content-Type: application/json" -X POST -d {"username":"foobar","password":"xxxxxxxxxxxxxxxxx", "email": "foo@bar.com"}' http://localhost/user/register 目前，我有这
..
openapi相关内容
Swagger:<string, Object> 的映射
我需要使用 Swagger 记录一个 API，该 API 将对象映射用作输入和输出，由字符串键索引. 例子: {“a_property":{“富":{"property_1": "一个字符串 1","property_2": "一个字符串 2"},“酒吧": {"property_1": "一个字符串 3","property_2": "一个字符串 4"}}} "foo" 和 "bar"
..
带有对象列表的 OpenAPI 查询字符串参数
我正在尝试使用 OpenAPI 记录一个看起来像 的查询字符串 filtered[0][id]=code&filtered[0][value]=12345 并包含具有 id 和 value 属性的对象列表. 我的 yaml 文档如下所示 参数:- 名称:过滤在:查询描述:要应用的过滤器爆炸:真实风格:deepObject架构:类型:数组项目:特性:ID:描述:要过滤的字段名称类型:字
..
如何在 OpenAPI 2.0 中定义混合类型数组(具有不同元素类型)?
我试图将以下 JSON 映射到 OpenAPI 2.0 (Swagger 2.0) YAML 定义，但我不确定如何将混合数组类型设置到我的架构中: {“obj1":[“字符串数据"，1]} 现在，我的 OpenAPI 定义有: 模式:对象1:类型:数组项目:类型:字符串 但这不允许在数组中使用整数. 有没有办法定义混合类型数组? 解决方案 答案取决于您使用的 OpenAPI
..
重用具有不同所需属性的模型
我有一个使用复杂模型的路径，每个 http 方法具有几乎相同的属性.问题是我想为 PUT 和 POST 的请求定义 一些 必需的属性，而 GET 响应中不需要任何属性(因为服务器总是返回所有属性，并且在文档的其他地方提到). 我创建了一个简单的 cat API 来演示我的尝试.这个想法是，对于 GET 响应，响应模型没有任何标记为 required，但 PUT 的请求必须具有 cat 的名称
..
如何在 OpenAPI (Swagger) 中记录动态查询参数名称?
有没有办法记录以下查询? GET api/v1/users?name1=value1&name2=value 查询参数名称是动态的，将从客户端接收. 我正在使用最新的 Swagger API. 解决方案 可以使用 OpenAPI 3.x 描述自由格式的查询参数，但不能使用 OpenAPI 2.0 (Swagger 2.0).该参数必须具有 type: object 和序列化方法
..
如何在 SwaggerHub 中返回对象数组?
我正在使用 OpenAPI 2.0 在 SwaggerHub 中定义 API 规范./contacts 请求返回一个联系人数组.定义如下: /contacts:得到:标签:- 联系人摘要:获取所有联系人描述:这会显示用户的所有联系人.operationId:获取联系人产生:- 应用程序/json- 应用程序/xml回复:200:描述:操作成功架构:$ref: '#/definitions/All
..
Swagger:如何让属性引用 OpenAPI 2.0 中的模型(即嵌套模型)?
我很难弄清楚如何在 OpenAPI 2.0 中嵌套模型. 目前我有: SomeModel:特性:道具1:类型:字符串道具2:类型:整数道具3:类型:$ref: 其他型号其他型号:特性:其他道具:类型:字符串 我尝试了很多其他方法: prop3:$ref: 其他型号# 或者道具3:架构:$ref: 其他型号# 或者道具3:类型:架构:$ref: 其他型号 上述方法似乎都不起作用.
..
如何为 OpenAPI 中的每个索引(即元组)定义一个带有具体项目定义的 JSON 数组?
我需要在 OpenAPI 中定义一个带有数组的 JSON 响应.该数组始终包含 2 个项目，第一个始终是数字，第二个始终是字符串. [1, "a"]//有效["a", 1]//无效[1]//无效[1, "a", 2]//无效 我发现 JSON 模式通过在 items 中传递项目列表而不是单个对象(source)，但 OpenAPI 明确禁止这样做并且只接受一个对象(来源).如何在 OpenAP
..
Camel Json 验证抛出 NoJsonBodyValidationException
我正在尝试对传入的 GET 请求执行标头验证.我提到了 Camel JSON 模式验证器组件 并按照以下步骤在我的项目中实现，即 在 build.gradle 中添加 camel-json-validator-starter 依赖 在我的 Spring boot 项目的 Resource 文件夹中添加 Employee.json(YAML 转换为 JSON).最初我在这里有 Open AP
..
如何重用 swagger 定义并删除其中的一些参数?
这是我的代码: 定义:用户:类型:对象特性:ID:类型:整数用户名:类型:字符串名:类型:字符串姓:类型:字符串密码:类型:字符串created_at:类型:字符串格式:日期时间更新地址:类型:字符串格式:日期时间必需的:- 用户名- 名- 姓- 密码/api/用户:邮政:描述:添加新用户operationId:商店参数:- 名称:用户描述:用户对象在:身体要求:真类型:字符串架构:$ref:
..
如何从 OpenAPI 3.0 yaml 文件生成 JSON 示例?
我有我的 openapi: 3.0.0 YAML 文件，我正在寻找一种从模式生成测试数据响应(JSON 对象)的方法.这 是我正在寻找的，但我无法让它为 openapi: 3.0.0 工作，代码有效非常适合“swagger":“2.0"定义.我试图让代码与支持 OpenAPI 3.0 的 Swagger Java 库 2.x 一起工作.我知道我需要使用 Swagger 2.x 版. import
..
如何在招摇属性中添加多个示例值?
我正在使用 Swagger OpenAPI 规范工具，我在以下定义之一中有一个字符串数组属性: 城市:类型:数组项目:类型:字符串例如:“浦那" 我的 API 生成 JSON 结果，因此对于上述对象，响应中会出现以下结果: {“城市":[“浦那"]} 尝试使用逗号分隔的字符串，如下所示: 城市:类型:数组项目:类型:字符串例如:“浦那"、“孟买"、“班加罗尔" 预期结果为: {“城市
..
在 springdoc-openapi-ui 中为承载令牌身份验证(JWT)启用授权按钮
如何在 springdoc-openapi-ui 中启用“授权"按钮(OpenAPI3.0 /swagger-ui.html) 用于承载令牌认证，例如 JWT. Spring @Controller 和 @Configuration 类需要添加哪些注解? 解决方案 使用注解 @io.swagger.v3.oas.annotations.security.SecurityScheme
..
Swagger/OpenAPI 模拟服务器
我在 Swagger 文件中有一个 API 参考.我想创建一个非常简单的模拟服务器，这样当我调用例如: mymockurl.com/users 它将返回一个预定义的 JSON(无需连接到数据库). 最简单的方法是什么?我不是后端人员. 解决方案 SwaggerHub 为 OpenAPI 2.0 和3.0 规格.免费和付费计划均支持模拟. 要使用模拟服务器，请将您的规范导入
..
如何使用 Swagger \ OpenAPI 记录 GraphQL?
如何使用 Swagger 记录 GraphQL?我们有一个巨大的后端 REST API，它最近已经部分开始使用 GraphQL.为了记录 API，我们使用 Swagger. 问题是:如何使用 Swagger(OpenAPI) 来记录 GraphQL 端点?Swagger 或 GraphQL 的官方文档中绝对没有相关信息. 解决方案 GraphQL API 通常通过 GraphQL 服
..
为什么 `additionalProperties` 是 Swagger/OpenAPI 2.0 中表示 Dictionary/Map 的方式
虽然我已经看到了 OpenAPI 规范中的示例: 类型:对象附加属性:$ref: '#/定义/复杂模型' 我不清楚为什么使用 additionalProperties 是地图/字典的正确模式. 规范中关于 additionalProperties 的唯一具体内容也无济于事: 以下属性取自 JSON 架构定义，但它们的定义已根据 Swagger 规范进行了调整.它们的定义与 JSON
..
使用 Swagger 3.0 发送 cookie 会话 ID
据说“要定义 cookie 身份验证，请改用 API 密钥."在官方文档中 https://swagger.io/docs/specification/describing-parameters/#cookie-参数 事实是我们尝试过 组件:安全方案:cookie验证:类型:apiKey在:饼干名称:sessionId...安全:- cookieAuth:[] 使用上面的代码，在
..
Swagger HashMap 属性类型
有没有办法在models部分定义HashMap或Generic Object类型?我有一个返回产品的 REST 服务，这些产品可以有不同的选择.options 属性基本上是一个 HashMap，其中 id 是选项名称，其值是选项值. 解决方案 是的，这是可能的. 在 OpenAPI (fka. Swagger) 2.0 和 3.0 中，哈希图始终是 映射: 键总是一个字符串，不
..
Swagger:<字符串，对象>的映射
我需要用 Swagger 记录一个 API，该 API 使用对象映射作为输入和输出，并由字符串键索引. 示例: {“a_property":{“富":{"property_1": "字符串 1","property_2": "字符串 2"},“酒吧": {"property_1": "字符串 3","property_2": "一个字符串 4"}}} "foo" 和 "bar" 可以是任
..