swagger-editor相关内容

Savagger编辑器如何指定请求正文(POST)中的哪些字段是必需的?

我正在尝试在联机Swagger编辑器中的User类上定义POST方法。 我希望能够在请求正文中指定多个字段,并且希望生成的文档反映只有2个字段是必需的,其他字段是可选的。 我必须做什么/更改才能做到这一点? 我尝试了使用";Required&Quot;关键字的各种变体(参见下图中的一个),但无法实现,它不会显示在生成的文档中(参见右下方带有红色注释的图片)。 以下是 ..
发布时间:2022-05-24 15:17:36 其他开发

使用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:不允许的其他属性:allOf

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

Swagger Editor 正文中的多个参数

所以我明白,如果我们想要身体参数,我们必须有一个模式,我就是这样做的.问题是无论我如何尝试定义我的架构,它都不允许我拥有多个正文参数.这是我尝试过的方法之一的示例.任何帮助都会很棒! 招摇:'2.0'# 这是你的文档元数据信息:版本:“0.0.1"标题:待办事项应用程序架构:{}主机:本地主机:3000方案:- http- https消耗:- 应用程序/json产生:- 应用程序/x-www-f ..
发布时间:2022-01-22 18:13:31 其他开发

Slate vs Swagger - 哪个更好,哪个有更多选择?

我必须记录我的 API.我必须使用其中任何一个 Slate 或 Swagger.我想知道哪个有更多的选择,利弊,哪个更好. 解决方案 Swagger 和 Slate 有两个不同的用途.Swagger 是一种描述 RESTful API 的标准化方式的尝试(例如,类似于 ApiBlueprint) Swagger 是一种基于 JSON 的 API 定义格式,允许描述 REST API. ..
发布时间:2022-01-22 18:12:34 其他开发

如何在没有用户在授权按钮处输入的情况下自动在 swagger 3.0 中添加基本身份验证?

我正在使用 swagger 3.0,并且在 swagger 文档中有多个端点. 我希望用户不要每次都在授权按钮处输入凭据. 有什么方法可以在 index.html 或我的 yaml 文件中包含身份验证以自动授权用户. 谢谢. 解决方案 Swagger UI 3.13.0+ 为此提供了 preauthorizeBasic 方法.假设您的 API 定义包含基本身份验证的安全方 ..
发布时间:2022-01-22 18:09:38 其他开发

从 Swagger Editor 发出请求时,如何避免 CORS 错误(“无法获取"或“未找到服务器或发生错误")?

我有以下 OpenAPI 定义: swagger: "2.0"信息:版本:1.0.0标题:简单的 API描述:学习如何编写 OpenAPI 规范的简单 API方案:- https主办方:now.httpbin.org路径:/:得到:摘要:以 rfc2822 格式获取日期回复:200:架构:类型:对象项目:特性:现在:类型:对象RFC2822:类型:字符串 我想从 响应中检索 rfc2822: ..
发布时间:2022-01-22 18:07:58 其他开发

node.js 上招摇的可空字段

我花了很多时间试图找到在 Node.JS 中创建 swagger 文档的解决方案.主库是 swagger-node,您可以在其中创建一个 swagger yaml 文件,然后将控制器添加到其中.它会自动在您的应用程序中提供 swagger ui 文档,并对请求进行验证响应您在 yaml 中指定的模型. 这很简洁,但是我有一个要求,我希望某些字段能够显式返回或接受 null 作为值,例如: ..
发布时间:2022-01-22 17:59:12 其他开发

如何在 OpenAPI/Swagger 中递归引用封闭类型定义?

我正在 Swagger Editor 中编写 OpenAPI 定义. 我的一个类型定义包含一个数组,其中包含与父元素相同类型的子元素.IE.像这样: 定义:树节点:类型:对象特性:名称:类型:字符串描述:树节点的名称.孩子们:类型:数组项目:$ref: '#/definitions/TreeNode' 但是,Swagger 编辑器不会在 children 数组中提取递归引用,它只是显示为 ..
发布时间:2022-01-22 17:49:55 其他开发

Swagger 编辑器显示“架构错误:不应该有其他属性";路径参数错误

我正在使用 http://editor.swagger.io 来设计 API,但出现错误我不知道如何解决: 路径中的架构错误['/employees/{employeeId}/roles'].get.parameters[0]不应该有额外的属性附加属性:类型、格式、名称、in、描述跳转到第 24 行 我有以类似方式定义的其他端点,并且没有收到此错误.我想知道缩进或未闭合的引号是否有问题,但似乎 ..
发布时间:2022-01-22 17:49:07 其他开发

如何在定义中创建某些操作而不是其他操作所需的字段

我正在用 yaml 编写我的招摇定义.假设我有一个看起来像这样的定义. 路径:/有效载荷:邮政:摘要:创建有效载荷...参数:- 在:身体名称:有效载荷描述:新的有效载荷要求:真架构:$ref:“#/定义/有效载荷"放:摘要:更新有效载荷...参数:- 在:身体名称:有效载荷描述:更新了现有的有效载荷要求:真架构:$ref:“#/定义/有效载荷"...定义:有效载荷:特性:ID:类型:字符串一些 ..
发布时间:2022-01-22 17:42:36 其他开发

针对 Swagger API 模式验证 JSON

我从一些 JSON 文件创建了一个 API 规范,我正在尝试测试这些文件是否符合 API 规范. 有一些很好的工具可以针对 JSON 模式进行验证,但我没有机会找到一个工具来验证在 Swagger 中创建的规范(用于创建 API 模式的工具).我找到的唯一解决方案是在 Swagger-Editor 中生成客户端/服务器,这很麻烦. 是否已有工具可以根据 Swagger Schema 验 ..
发布时间:2022-01-22 17:40:08 其他开发

如何包装 JSON 对象?

我目前正在寻找一种将 JSON 包装到 Swagger UI 组件中的方法. 在 YAML 中,我的对象声明是: 休息异常:特性:信息:类型:字符串 Swagger UI 生成的输出是(我同意,是正确的):{“消息":“字符串"} 而我想要的是: "restException": {“消息":“字符串"} 我只是通过在 YAML 文件中明确声明包装器找到了一种丑陋的方法.但这 ..
发布时间:2022-01-22 17:36:13 其他开发