Swager 2.0参考规范

Question

我在尝试格式化这个OpenApI(Swagger) Json文件时遇到了挑战。当我试图与https://editor.swagger.io/,确认时，我得到了错误。

$ref值必须是符合 RFC3986 的百分比编码 URI

当我将文件中架构的$ref属性从$ ref:' #/definitions/GetResponse[List[currency model]]'更改为$ ref:%/definitions/GetResponse[List[currency model]]'时

错误消失了，但随后请求和响应都没有显示正确的模型，而是显示字符串。请参阅下面的屏幕截图。第一张图像带有 #，第二张图像带有 %

swagger: '2.0'
info:
  version: v1
  title: API
  contact:
    name: DEMO
paths:
  /api/Currency/GetCurrencies:
    get:
      tags:
        - Currency
      summary: Get List of Currencies
      description: ''
      operationId: GetAllCurrencies
      consumes: []
      produces:
        - text/plain
        - application/json
        - text/json
      parameters: []
      responses:
        '200':
          description: Returns list of Currencies
          schema:
            $ref: '#/definitions/GetResponse[List[CurrencyModel]]'
        '400':
          description: If an error occur
          schema:
            $ref: '#/definitions/GetResponse[ProducesResponseStub]'
        '404':
          description: If the list of Currencies is null
          schema:
            $ref: '#/definitions/GetResponse[ProducesResponseStub]'
definitions:
  GetResponse[List[CurrencyModel]]:
    type: object
    properties:
      status:
        type: boolean
      data:
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/CurrencyModel'
      message:
        type: string
  CurrencyModel:
    type: object
    properties:
      id:
        format: int32
        type: integer
      name:
        type: string
      code:
        type: string
      currencyUTF32Code:
        format: int32
        type: integer
      currencySymbol:
        type: string
        readOnly: true
securityDefinitions:
  Bearer:
    name: Authorization
    in: header
    type: apiKey
    description: Please insert JWT with Bearer into field
security:
  - Bearer: []

Answer 1

有两个问题：

> < li>

您的API定义缺少在某些refs中使用的< code > GetResponse[produce response stub]和< code > GetResponse[produce response stub]模式。您需要添加缺少的模式，或者删除相应的$refs。

如果某些架构名称包含特殊字符，则必须在$ref路径中对它们进行 URL 编码。将 [ 替换为 [ 和 ] 替换为 ]，例如：

# Incorrect
$ref: '#/definitions/GetResponse[List[CurrencyModel]]'

# Correct
$ref: '#/definitions/GetResponse%5BList%5BCurrencyModel%5D%5D'

或者更好的是，不要在模式名称中使用特殊字符。