Question

我想要放入yaml文件的响应示例如下：

{ "name": "Element", "schema": { "properties": { "id": { "type": "string" }, "extension": { "type": "array", "items": { "$ref": "#/definitions/Extension" } } } } }

此示例的ymal为：

responses:
    200:
      description: "successful operation, return the definition of the resource type in the body"
      examples:
        application/json:
          name: Element
          schema:
            properties:
              id:
                type: string
              extension:
                type: array
                items: 
                  $ref: '#/definitions/Extension'

您可以看到最后一行是“ $ ref：'＃/ definitions / Extension'”，因此Swagger认为这是一个在ymal文件中找不到的引用。

是否有可能避免这种情况以成为参考？

Answer 1

这是Swagger编辑器和UI中的a bug。

作为一种解决方法，为您的响应定义一个<input type="submit" formaction="@Url.Action("CreateCtrlOption")" id="ctrlOptionSubmit" value="Create" class="btn btn-default" />并改用一个模式示例。架构示例在Swagger编辑器3.6.6和Swagger UI 3.17.5中可以很好地显示。您可能仍会在编辑器中看到$ ref解析错误，但至少示例显示正确。

schema

$ ref作为响应示例

1 个答案: