AWS CDK 如何从 OpenApi 规范创建由 Lambda 支持的 API 网关?
我想使用 AWS CDK 定义 API 网关和 APIG 将代理到的 lambda. OpenAPI 规范支持对 Swagger 规范的 x-amazon-apigateway-integration 自定义扩展(详细 here)，需要 lambda 的调用 URL.如果 lambda 定义在与 API 相同的堆栈中，我看不到如何在 OpenAPI 规范中提供它.我能想到的最好的方法是定义一
..
openapi相关内容
springdoc-openapi 应用默认全局 SecurityScheme 可能吗?
我有以下 SecurityScheme 使用 springdoc-openapi 为 java SpringBoot RESTful 应用定义: @Bean公共 OpenAPI customOpenAPI() {返回新的 OpenAPI().components(new Components().addSecuritySchemes("bearer-jwt",新的 SecurityScheme
..
如何在没有用户在授权按钮处输入的情况下自动在 swagger 3.0 中添加基本身份验证?
我正在使用 swagger 3.0，并且在 swagger 文档中有多个端点. 我希望用户不要每次都在授权按钮处输入凭据. 有什么方法可以在 index.html 或我的 yaml 文件中包含身份验证以自动授权用户. 谢谢. 解决方案 Swagger UI 3.13.0+ 为此提供了 preauthorizeBasic 方法.假设您的 API 定义包含基本身份验证的安全方
..
大摇大摆地相互排斥属性
我如何表明在 my_object 中可以有 property_1 或 property_2，但不能同时有? my_object:类型:对象特性:属性_1:类型:字符串属性_2:类型:字符串 解决方案 你可能想切换到OpenAPI 3.0，它支持oneOf关键字定义互斥条件: 这是一个例子: my_object:类型:对象特性:属性_1:类型:字符串属性_2:类型:整数一个:- 必需
..
使用 Swagger/OpenAPI 创建可扩展模型
在我的 API 中，我想为我的收藏提供一个简单的模型，并为我的个人资源提供一个更精细的模型.例如: /libraries 上的 GET 请求应返回 BaseLibrary:类型:对象特性:library_id:类型:字符串描述:图书馆的id显示名称:类型:字符串描述:图书馆名称参考资料:类型:字符串描述:链接到这个库的 URI. 虽然对特定库的请求应返回上述所有内容，包括额外的参数boo
..
从 Swagger Editor 发出请求时，如何避免 CORS 错误(“无法获取"或“未找到服务器或发生错误")?
我有以下 OpenAPI 定义: swagger: "2.0"信息:版本:1.0.0标题:简单的 API描述:学习如何编写 OpenAPI 规范的简单 API方案:- https主办方:now.httpbin.org路径:/:得到:摘要:以 rfc2822 格式获取日期回复:200:架构:类型:对象项目:特性:现在:类型:对象RFC2822:类型:字符串 我想从 响应中检索 rfc2822:
..
Autorest 错误 - swagger.json' 不是有效的 OpenAPI 2.0 定义(预期为 'swagger: 2.0')
我的 api 正在运行带有 Swashbuckle.AspNetCore 5.0.0-rc5 的 net core 3.0 当我在生成的 swagger.json 文件上运行 autorest 时，我得到: swagger.json 不是有效的 OpenAPI 2.0 定义(预期为 'swagger: 2.0') 我的 swagger.json 文件确实说“openapi":“3.0.1
..
如何在 OpenAPI 2.0 中为同一操作定义 path 和 formData 参数?
我有一个类似于 /test/{id}/relationships/image 的图像上传端点.我想使用 OpenAPI 2.0 (Swagger 2.0) 来描述这个端点. 端点同时具有 path 和 formData 参数.我尝试了以下方法: swagger: '2.0'信息:标题:API版本:1.0.0主机:api.server.de方案:- https产生:- 应用程序/json路径
..
如何在 OpenAPI (Swagger) 中将 $ref 属性声明为只读?
我正在尝试在此示例中为“House"添加一个只读字段.房子是另一个我想只读的模型. 在此示例中，Dogs 数组可以设置为 readOnly 而不会出错，但是当我将 House 的单个定义设置为 readOnly 时，我收到以下警告在 Swagger 编辑器中: 同级值不允许与 $refs 一起使用 我知道这是因为模型中的所有内容都在这里继承.那么如何定义 write API 调用
..
如何为 OpenAPI 3.0.0 运行 swagger-codegen
看起来像官方 swagger for openapi 规范 V3 支持即将发布 https://blog.readme.io/an-example-filled-guide-to-swagger-3-2/，并且 swagger-codegen 已经开发了 3.0.0 支持并通过了一定程度的测试 3.0.0 分支上的 rel="noreferrer">https://github.com/swagg
..
不允许的附加属性:可为空的招摇
我正在使用带有 node.js express 4.12.3 和 mysql db 的 swagger 2.0. 我创建了以下架构 - 国家:类型:“对象"特性:ID:类型:“整数"只读:真描述:“国家 ID"国家:类型:“字符串"描述:“国家名称"created_at:类型:“字符串"只读:真格式:“日期时间"描述:“国家记录创建日期"已删除_at:类型:“字符串"格式:“日期时间"描
..
如何在 OpenAPI (Swagger) 中用方括号定义参数?
我有一个带有使用方括号的查询参数的端点: GET/info?sort[name]=1&sort[age]=-1 这里，name 和 age 是我的模型定义中的字段名称. 如何为这些参数编写 OpenAPI (Swagger) 定义? 解决方案 这取决于你使用的 OpenAPI (Swagger) 版本. OpenAPI 3.x sort 参数可以定义为具有 name
..
适用于 OpenAPI 3.0 的 Swagger Codegen(带有 maven 插件)
我想为 OpenAPI 3.0 YAML 文件使用 Swagger Codegen.我看到 Swagger Codegen 3.0.0-rc0 可用.但是当我尝试使用它时，我遇到了问题.详情如下: 我的 pom.xml 文件带有 swagger-codegen 插件: io.swaggerswagger-codegen-
..
OpenAPI 中的“必需"到底是什么意思
鉴于以下 OpenAPI 定义，以下哪些对象是有效的.只有 1. 或 1. 和 2.? 人员:必需的:- ID类型:对象特性:ID:类型:字符串 {"id": ""} {"id": null} {} 这归结为“required = true"是指“非空值"还是“必须存在属性"的问题. https://json-schema-validator.herokuapp.com/上的
..
如何使用 OpenAPI 规范保持单一资源表示方法
阅读此post(参见:3 How to use a single definition when...)关于使用 OpenAPI 描述 REST API(Swagger) 规范，您可以注意如何使用 readOnly 属性保留单个资源表示来添加/更新和获取资源，而不是使用一种表示来获取(获取集合项)和另一种表示用于添加(POST 到一个集合).例如，在下面的 User 单一表示中，id 是一个只读属
..
在 Swagger 中，如何定义一个使用文件和模式参数的 API?
我正在尝试使用 Swagger 定义一个接受实际文件和描述文件内容的模式对象的 API.这是 Swagger YAML 的一个片段.但是，它不会在 Swagger 编辑器中验证. /document:邮政:摘要:API摘要描述:API 描述消耗:- 多部分/表单数据参数:- 名称:documentDetails在:表格数据描述:文档详细信息要求:真架构:$ref: '#/定义/文档'- 名称:文
..
如何在 OpenAPI/Swagger 中递归引用封闭类型定义?
我正在 Swagger Editor 中编写 OpenAPI 定义. 我的一个类型定义包含一个数组，其中包含与父元素相同类型的子元素.IE.像这样: 定义:树节点:类型:对象特性:名称:类型:字符串描述:树节点的名称.孩子们:类型:数组项目:$ref: '#/definitions/TreeNode' 但是，Swagger 编辑器不会在 children 数组中提取递归引用，它只是显示为
..
如何使用 Swagger\OpenAPI 记录 GraphQL?
如何使用 Swagger 记录 GraphQL?我们有一个庞大的后端 REST API，最近部分开始使用 GraphQL.我们使用 Swagger 来记录 API. 问题是:如何使用 Swagger(OpenAPI) 来记录 GraphQL 端点?Swagger 或 GraphQL 的官方文档中绝对没有相关信息. 解决方案 GraphQL API 通常通过 GraphQL 服务器本身
..
如何在 Swagger 中为 GET 参数指定示例?
我正在使用在线 Swagger Editor 为我的 API 创建 Swagger 规范. 我的 API 有一个 GET 请求端点，我使用以下 YAML 代码来描述输入参数: 路径:/fooBar:得到:标签:- 富吧概括: ''描述: ''operationId: foobar消耗:- 应用程序/x-www-form-urlencoded产生:- 应用程序/json参数:- 姓名:地址在
..
Swagger 编辑器显示“架构错误:不应该有其他属性"；路径参数错误
我正在使用 http://editor.swagger.io 来设计 API，但出现错误我不知道如何解决: 路径中的架构错误['/employees/{employeeId}/roles'].get.parameters[0]不应该有额外的属性附加属性:类型、格式、名称、in、描述跳转到第 24 行 我有以类似方式定义的其他端点，并且没有收到此错误.我想知道缩进或未闭合的引号是否有问题，但似乎
..