Swashbuckle 如何将 OneOf 声明添加到 OpenAPI 3
我有一个请求对象，它可以是 2 种字符串类型“A"；或“B". 注意:这是我真正想要的一个更简单的例子.枚举在这里对我不起作用. 公共类 SampleRequest{//只能是“A"或“B"公共字符串 Property1 { 获取；放;}} 我正在尝试创建一个可以作为 OpenAPI“OneOf"输出的模式过滤器.属性. https:///datatracker.ietf.org/
..
openapi相关内容
API 平台 - 如何记录身份验证路由
我在 Symfony 4 Flex 应用程序中使用 API Platform v2.2.5，该应用程序由一个具有 JWT Authentication、大量资源和默认的打开可通过 /api 路由访问的 API/Swagger 文档页面.每个 API 资源都通过平台配置自动包含在文档中，根据 图书馆文档. 您如何为自定义操作(例如安全组件的身份验证路由)生成文档?API 平台文档 似乎不包含这
..
开放API继承示例数据
我正在使用 OpenAPI 3.0 为我正在构建的服务定义 API.我遇到了在其他组件中重用架构组件的问题.例如，我有一个 Note 对象，其中包含创建笔记的人的 Profile 对象.这通过使用 $ref 关键字引用 Profile 对象来按预期工作.问题是在显示示例时没有配置文件的任何数据，如果我将引用放在下面的示例中，它包括 Profile 的实际 OpenAPI 块，而不仅仅是用于配置文件
..
OpenAPI 3.0 模拟生成器
我正在学习 OpenAPI 规范.是否有任何工具可以基于 YAML 格式的 OpenAPI 定义来模拟 API? 解决方案 SwaggerHub 包括一个用于 OpenAPI 3.0 和 2.0 规范的模拟服务器.付费和免费计划都提供模拟功能. 要使用模拟服务器，请将您的规范导入 SwaggerHub 并启用“API 自动模拟".模拟响应可以是 JSON、YAML 和 XML，并根据
..
从另一个 Swagger 或 OpenAPI 文件为某些端点生成 Swagger 文件
拥有一个庞大的 Swagger/OpenAPI YAML 规范，我如何才能安全地提取某些 API 端点并专门为它们生成一个新的 .yaml? 从某个级别(例如使用一个或多个缩进定义)识别 API 端点很容易: 路径:/用户:...- $ref: '#/requests/getUser'/回购:...要求:获取用户:... 我只是将所有部分(paths 除外)复制到一个新的规范文件中.然
..
如何重用swagger定义并删除其中的一些参数?
这是我的代码: 定义:用户:类型:对象特性:ID:类型:整数用户名:类型:字符串名:类型:字符串姓:类型:字符串密码:类型:字符串created_at:类型:字符串格式:日期时间更新时间:类型:字符串格式:日期时间必需的:- 用户名- 名- 姓- 密码/api/用户:邮政:描述:添加一个新用户操作 ID:存储参数:- 姓名:用户描述:用户对象在:身体要求:真实类型:字符串架构:$ref: '#/
..
如何将多个 OpenAPI 3 规范文件组合在一起?
我想合并使用 OpenAPI 3 规范编写的 API 规范，该规范目前分为多个文件，这些文件使用 $ref 相互引用.我该怎么做? 解决方案 一种方法是使用开源项目 speccy. 打开终端并通过运行安装speccy(需要Node.js): npm install speccy -g 然后运行: speccy resolve path/to/spec.yaml -o
..
OpenAPI 或 swagger.json 自动发现
是否有任何关于 URL 的规范或约定应该放置 swagger.json(或同意的任何名称)，以便可以自动发现我网站的公共 API? 解决方案 2017 年 4 月 19 日更新:我之前给出的 OpenAPI Wiki 答案是 "对于非常非常旧的规范版本".同一来源指出，对于 2.0，标准是 swagger.json，对于 3.0，它更改为 openapi.json. 原答案:
..
如何使用 Swashbuckle 在 Swagger API 文档/OpenAPI 规范中包含子类?
我在 C# 中有一个 Asp.Net Web API 5.2 项目，并使用 Swashbuckle 生成文档. 我有包含继承的模型，例如从 Animal 抽象类和派生自它的 Dog 和 Cat 类的 Animal 属性. Swashbuckle 只显示 Animal 类的模式，所以我尝试使用 ISchemaFilter(他们也建议这样做)，但我无法使其工作，也找不到合适的示例.
..
OpenAPI:接受任何(复杂)JSON 值的模式
我为其编写 Swagger 2.0 规范的 API 基本上是任何 JSON 值的存储. 我想要一个读取值的路径和一个存储任何非预定义深度的 JSON 值(空值、数字、整数、字符串、对象、数组)的路径. 不幸的是，Swagger 2.0 似乎对输入和输出的模式非常严格，并且不允许使用 JSON 模式允许的整个模式集.Swagger 编辑器不允许例如混合值(例如可以是布尔值或整数的属性)或
..
用 swagger 发布一个 json body
我想用 Swagger 发布一个 json 正文，如下所示: curl -H "Content-Type: application/json" -X POST -d {"username":"foobar","password":"xxxxxxxxxxxxxxxxx", "email": "foo@bar.com"}' http://localhost/user/register 目前，我有这
..
骆驼 Json 验证抛出 NoJsonBodyValidationException
我正在尝试对传入的 GET 请求执行标头验证.我提到了 Camel JSON 模式验证器组件 并按照以下步骤在我的项目中实现，即 在 build.gradle 中添加camel-json-validator-starter 依赖 在我的 Spring Boot 项目的 Resource 文件夹中添加 Employee.json(YAML 转换为 JSON).这里最初我有 Open API
..
使用 Swagger 注释显示自定义 HashMap 键
我正在尝试从 Java 代码生成 Swagger 文档，我的嵌套模型属性之一是 HashMap.为它生成的示例如下: "additionalProp1": {“自定义对象":{}},“附加道具2":{“自定义对象":{}},“附加道具3":{“自定义对象":{}} 我需要它看起来像: "objectName": {“自定义对象":{}} 换句话说，我需要告诉他们 additionalP
..
Swashbuckle 如何将 OneOf 声明添加到 OpenAPI 3
我有一个请求对象，它可以是 2 种字符串类型“A"；或“B". 注意:这是我真正想要的一个更简单的例子.枚举在这里对我不起作用. 公共类 SampleRequest{//只能是“A"或“B"公共字符串 Property1 { 获取；放;}} 我正在尝试创建一个可以作为 OpenAPI“OneOf"输出的模式过滤器.属性. https:///datatracker.ietf.org/
..
|, > 和有什么区别?和 >- 在 OpenAPI YAML 描述中?
我正在查看 OpenAPI 和 description 标签.这些标签有什么区别?它们都支持多行，但还有别的吗? 描述: |描述:>描述:>- 解决方案 description 不是 YAML “标签"，它只是您正在编辑的 YAML 文件中的一个字段/属性，例如 OpenAPI 或 Swagger 文档. YAML 规范在此处描述了不同的文本折叠样式:https://yaml.org/
..
将 XSD 导入 OpenAPI
我在 XSD 文件中有一些模型定义，我需要从 OpenApi 定义中引用这些模型.由于文件太大，无法手动重构，我需要将其放入构建系统，以便在更改 XSD 时，我可以为 OpenApi 重新生成模型/架构. 我尝试过的和几乎有效的方法是使用 xsd2json 然后用节点模块转换它 使用转换器主类，可以执行以下操作: package foo.bar;导入 com.fasterxml.ja
..
在 openapi v3 中创建通用路径和特定路径
我正在为 node.js 服务器使用 express-openapi npm 模块.为此，我需要使用 openapi v3 创建一个通用 url，像这样一个/ressources/{action} 它将包括所有类型的动作，除了一些我特别描述为/ressources/action1 和/ressources/action2这里我是如何描述 url 路径中的通用参数的: 动作:名称:动作在:路径要
..
有没有办法在打字稿中为 Azure Functions 自动生成 swagger 文档?
我正在为我的项目使用带有 azure 函数的 typescript 和 node.我想为我的项目自动生成 openAPI 定义文件，而不是手动创建一个.我看到了 https://www.nuget.org/packages/Aliencube.AzureFunctions.Extensions.OpenApi/ 包，用于使用 C# 处理此问题，但我目前找不到等效的打字稿.是否有等效的打字稿或我需要
..
如何在 OpenAPI 中定义枚举映射?
我正在设计一个 API，我想定义一个枚举严重性，它的值可以是低、中或高.在内部 Severity 被存储为一个整数，所以我想分别将它们映射到 2,1 和 0.有没有办法在 OpenAPI 定义中做到这一点?这是目前我对严重性的要求: 严重性:类型:字符串枚举:- 高的- 中等的- 低的 解决方案 OpenAPI 3.1 OpenAPI 3.1 使用最新的 JSON Schema，以及
..
在spring boot中使用openapi使用@Schema(allowableValues=)作为枚举参数
我的 API 在请求正文中有一个 enum 字段.当我生成 swagger UI 时，它显示的枚举具有允许的值作为枚举名称.我需要将其设置为枚举值，而不是枚举名称.为此，我使用了 @Schema(allowableValues=).这会在 swagger UI 中生成一个包含值和名称的列表.我可以仅在 swagger 中将其设置为值吗? 我的枚举示例: 公共枚举 Days{MON(“星期
..