当前位置: 首页 > 知识库问答 >
问题:

Swagger上的多个400响应示例

赵智勇
2023-03-14

我用虚张声势的皮带扣。AspNetCore库生成Swagger文档。是否可以将多个错误消息添加到一个状态代码中?例如,我有一个字段,它有验证,所以我需要在我的文档中使用它:

Code   Description
 400   Invalid format
       Field is required
       Should be greater than 10

在以前版本的库中,我可以将验证错误放入描述中,但该属性在最新版本中不可用。我们有没有描述参数的属性。

共有1个答案

壤驷康裕
2023-03-14

你可以使用Swashback。AspNetCore。过滤器以指定多个示例。

  1. 有关如何启用过滤器的信息,请参阅本节:安装我专门添加了过滤器()和服务。将SwaggerExamplesFromAssemblies(Assembly.GetEntryAssembly())添加到我的启动中。cs
  2. 参见本节了解如何创建多个示例:多示例设置
  3. 有关用法的详细信息,请参阅本节:使用多个示例,文档提到了使用“SwaggerResponse”和“SwaggerResponseExample”注释,但我仅使用“SwaggerResponseExample”就能够达到预期效果
 类似资料:
  • 当我将示例添加到我的swagger文档中并在swagger编辑器上进行测试时,它在任何地方都不会显示。有人能给我举一个例子,说明在什么地方有多个例子吗? 它来自:https://swagger.io/docs/specification/adding-examples/ 以下是一个yaml示例,它在在线招摇过市编辑器上不显示任何:

  • 我试图记录一个总是返回自定义响应代码和相关描述的模型。对于单个HTTP响应代码,可以有多个自定义响应代码。例如,400响应可能包括: 我可以记录400状态返回一个“Error”对象,该对象具有“Code”和“Description”。但如果可能的话,我想在文档中包含所有自定义状态代码。有可能吗?如果是这样,我该怎么做?

  • 我使用的是openapi 3.0.2版。 我有以下规范描述了我的响应: 对于大多数响应代码,我不返回任何响应体,但是对于400响应代码,我想返回错误对象: 当我为这个endpoint生成Java服务器代码时,方法的返回类型是,这意味着我不能返回错误对象? 似乎与这些问题类似: https://groups.google.com/forum/#!topic/swagger-swaggersocket

  • 目前正在使用springfox 2.9.2大摇大摆地记录Spring中创建的API。我想在文档中添加示例响应,如下图所示; 我的理解是,我可以做类似的事情: 在本例中,我将此代码片段放在方法的正上方。不幸的是,上面的两个示例总是显示:标识符预期错误 但我也看到我也能做到这一点: 我还看到我可以添加一个级别的示例: 我的问题是: > 将Swagger/Springfox指向my model/bean

  • 我是招摇过市的新手,正在从事创建通用http响应代码的API操作:- > 401:未经授权 '403':禁止 我通过定义响应尝试了,但出现了一个错误。有没有办法做到这一点?,避免每次操作后出现冗余代码块。任何帮助都将不胜感激。 提前感谢

  • 我有一个API,成功后返回以下响应: 或者在失败时像下面这样: 只有在请求成功时才会指定filename属性,但如果出现错误,则会提供消息。这意味着消息和文件名属性是“可选的”,但结果属性是必需的。 我尝试在定义中定义这个响应对象,如下所示: 但似乎swagger不喜欢“必需”属性,并将显示以下错误消息: 当我看一个来自swagger的例子时,他们有以下布局,其中有两个不同的响应定义,而不是一个。