swagger相关内容

如何在 swagger 规范中表示十进制浮点?

我想在我的 api 文档中用 2 位表示小数,用 1 位表示小数.我正在使用 swagger 2.0,规范中是否有内置定义类型或任何其他“圆形"参数,或者我唯一的选择是使用“x-"扩展名? 解决方案 OpenAPI (fka Swagger) 规范使用 JSON Schema 来描述数据类型. 如果参数作为数字传递,您可以尝试使用 this Q& 中建议的 multipleOf一个: ..
发布时间:2022-01-22 18:32:51 其他开发

在 SwashBuckle 中使用 IOperationFilter 删除路由

我正在寻找一种在 Swagger 文档中以可配置的方式使用 SwashBuckle 显示/隐藏 WebAPI 路由的方法.添加 [ApiExplorerSettings(IgnoreApi = true)] 确实会隐藏路由,但每次我想要更改时都需要重新编译. 我已经研究过创建一个 IOOperationFilter 以使用我定义的自定义属性.这样我就可以用 [SwaggerTag("Mobi ..
发布时间:2022-01-22 18:32:22 C#/.NET

使用 Swashbuckle 生成 yaml 招摇

使用 微软的教程. 由于某些要求,我希望能够检索 yaml 文件.但问题是我找不到任何钩子让这成为可能. 有没有人知道任何解决此问题的解决方法? 解决方案 V 5.6 支持生成 YAML 文件.使用方法: app.UseSwaggerUI(x => { x.SwaggerEndpoint("/swagger/v1/swagger.yaml", "Zeipt Dashboard ..
发布时间:2022-01-22 18:32:14 C#/.NET

如何使用 swagger/OpenAPI 指定替代响应格式?

我有一个 swagger.yaml 是这样的: 招摇:“2.0"路径:/某物:得到:参数:- 名称:格式在:查询类型:字符串模式:'^(csv|json|xml)$'回复:200:架构:类型: ? 我想根据 format 查询参数的值(例如 localhost/api/something?format=csv)返回不同的格式(csv、json、xml). 如何在规范中指定不同的响应格式? ..
发布时间:2022-01-22 18:32:06 其他开发

大摇大摆地处理多个基本路径

我正在使用 swagger-ui 为我们的客户提供很好的 REST API 文档.在内部,我们有两个不同的环境 jenkin 构建项目.例如.swagger.json 在两种环境中都可以访问:http://www.myhost.com/xyz/rest/swagger.jsonhttps://www.myhost2.com/rest/swagger.json 文档可用于:http://www ..
发布时间:2022-01-22 18:31:59 Java开发

我怎样才能将微服务招摇聚合成一个招摇

我正在尝试在我的微服务项目中生成一个 swagger,在 Api Gateway 中将所有服务 swagger 聚合为一个.为了实现这一点,我正在关注下一个教程 https://objectpartners.com/2017/09/28/aggregate-services-into-a-single-swagger 这里的问题是,当我尝试设置绝对 URL 时,我收到的输出是 无法加载 AP ..
发布时间:2022-01-22 18:31:55 其他开发

Swagger-ui 锚链接到模型定义

是否可以通过锚点直接访问通过 swagger-ui 的模型定义? 在示例页面 http://petstore.swagger.io/ 我看到锚适用于一组端点,例如http://petstore.swagger.io/#/pet. 将鼠标悬停在模型描述上会显示一个锚点(例如 Category 模型的 #/definitions/Category),但是http://petstore.sw ..
发布时间:2022-01-22 18:31:44 前端开发

django-rest-swagger 是否不适用于模型序列化器?

我已经离开了 django-rest-swagger github 页面上的文档,更具体地说,称为“它是如何工作的"的部分.它表明您可以为您的 rest api 定义自己的参数,并将这些参数显示在您的 swagger 文档页面中. 评论的例子是这样的: """此文本是此 API 的说明param1 -- 第一个参数param2 -- 第二个参数""" 我可以让它工作,但我的问题是如何指定 ..
发布时间:2022-01-22 18:30:23 Python

Web Api - Swagger 文档错误 500

当我访问 swagger url: http://localhost:28483/swagger/ui/index 时,它会生成这个错误: 500 : 未定义 http://localhost:28483/swagger/docs/v1 有什么想法吗? 更新:在 firebug 中查看此详细错误: Swagger 2.0 不支持:多个操作使用路径“api/BimModel"和方法“GE ..
发布时间:2022-01-22 18:30:14 其他开发

Swagger WebApi 在构建时创建 json

在我的 web api 的构建任务中,有什么方法可以创建 swagger json?我想使用 json 将其输入代码生成器并生成打字稿定义文件. 非常欢迎任何帮助! 解决方案 你可以像这样使用 NSwag 命令行工具: nswag.exe webapi2swagger/assembly:"path/to/assembly.dll"/output:"path/to/swagger.j ..
发布时间:2022-01-22 18:30:05 其他开发

调试 Swashbuckle 错误 - 无法加载 API 定义

有没有办法获得堆栈跟踪或 Swashbuckle/Swagger 错误的内部异常?在某些时候,它停止了工作.我不确定是不是在我从 .Net Core 2.0 升级到 2.1 时,但我很确定它在那之后仍然可以工作.当我导航到 myapidomain/swagger/index.html 时,我收到此错误: 这不是很有帮助.大约两周前它还在工作……我没有更改任何 Swagger 配置.一如既往: ..

要求数组在 Swagger Schema 对象定义中至少包含一个元素

我的 swagger.yaml 中有这样的架构对象定义: 用户:类型:对象特性:用户名:类型:字符串描述:用户名颜色:类型:数组项目: {类型:字符串,枚举:[“红色"、“蓝色"、“绿色"]}描述:用户必须关联一种或多种颜色必需的:- 用户名- 颜色 但是,生成的服务器仍然很乐意接受使用此架构对象作为不包含任何 colors 字段的必需主体参数的 POST 请求. 我能否以 color ..
发布时间:2022-01-22 18:29:35 其他开发

如何让 Swagger UI 的参数成为下拉菜单而不是文本输入

我正在使用 swagger 来显示我的 RESTApi,API 的一个参数将字符串作为输入并将其转换为枚举值.有没有办法在 Swagger UI 上显示下拉菜单,而不是文本输入字段,以便用户只能选择枚举值中的字符串值. 解决方案 关键是要使用allowableValues 在 @ApiParam 注释中. 演示结果: http://petstore.swagger.io/#!/ ..
发布时间:2022-01-22 18:29:21 Java开发

Swagger (Swashbuckle) 隐藏页眉

我使用 Swashbuckle 将 Swagger 文档添加到我的 ASP.NET Web API 项目中.如何在不注入 CSS 的情况下从文档页面隐藏默认标题(带有 swagger 标志)? 解决方案 不幸的是,我认为你现在可以通过 javascript 完成. 在您的 SwaggerConfig.cs 中,您可以像这样注入一个 .js 文件: .EnableSwaggerUi( ..
发布时间:2022-01-22 18:29:14 其他开发

Swagger..无法呈现此定义 提供的定义未指定有效的版本字段

无法呈现此定义 提供的定义没有指定一个有效的版本字段. 请指明有效的 Swagger 或 OpenAPI 版本字段.支持的版本字段是 swagger: "2.0" 和那些匹配 openapi: 3.0.n(例如,openapi: 3.0.0). 我需要在哪里插入正确的版本来停止下面的错误.Swagger 编辑器工作正常,但在启动特定项目时我收到此错误.第一次使用 Swagger.非常感 ..
发布时间:2022-01-22 18:28:58 前端开发