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

Swagger$ref http响应

颛孙昆
2023-03-14

我是招摇过市的新手,正在从事创建通用http响应代码的API操作:-

>

  • 401:未经授权

    '403':禁止

    我通过定义响应尝试了$ref:#/definitions/responses,但出现了一个错误。有没有办法做到这一点?,避免每次操作后出现冗余代码块。任何帮助都将不胜感激。

    提前感谢

  • 共有1个答案

    华哲茂
    2023-03-14

    找到了答案,

    这可以用于引用其他文件的通用响应(在我的情况下)。也可以从文件中引用。

     '400':
          $ref: _http-responses.yaml#/400
        '401':
          $ref: _http-responses.yaml#/401
        '403':
          $ref: _http-responses.yaml#/403
        '404':
          $ref: _http-responses.yaml#/404
        '500':
          $ref: _http-responses.yaml#/500
    

    我创造

    _http_responses.yaml

    然后引用它。

     类似资料:
    • 在Swagger UI中有没有美化响应体中JSON的方法?我用的是SwaggerUIBundle。

    • 我在一个...NET Core 3.1项目,将我的XML注释导入到Swagger中。我在一个控制器上有一个POST请求,我想在Swagger中注册一些响应状态(201, 401, 403, 404)。问题是,在文件和Swagger UI界面中,我还看到一个200成功响应与我显式指定的状态代码响应并列。 正如在多个不同的地方建议的那样,我正在使用属性来尝试并防止这种情况,但是我所尝试的一切仍然会导致

    • 我用虚张声势的皮带扣。AspNetCore库生成Swagger文档。是否可以将多个错误消息添加到一个状态代码中?例如,我有一个字段,它有验证,所以我需要在我的文档中使用它: 在以前版本的库中,我可以将验证错误放入描述中,但该属性在最新版本中不可用。我们有没有描述参数的属性。

    • 我可以这样做: 然而,这似乎不起作用。我返回到的规范,注意到可以是引用对象,但不能。 如果您无法引用响应定义对象(最顶层的)中的项,那么允许该对象的意义何在?有没有办法做到这一点?

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

    • 从我的Java后端,我正在使用另一个我不管理的后端,它的API定义不可用。我正在创建它的服务的OpenAPI定义,并使用Swagger Codigen来生成客户端。 有一个endpoint返回一个复杂对象: 在该对象中,和始终存在,但在同一级别上有数百个动态项。在上面的示例中,关键点是可以预测的,但实际上是字母和数字的序列,类似于“245df921”。动态项始终是具有相同项数和相同预期位置的数组。