Swagger-YAML 错误映射条目

Posted 2023-02-26

【中文标题】Swagger-YAML 错误映射条目

【英文标题】：Swagger-YAML Bad Mapping entry

【发布时间】：2017-06-14 09:06:28

【问题描述】：

我尝试使用 Swagger 和 YAML 生成 REST API 定义， 但在$ref: '#/definitions/Token' 我得到了错误

映射条目的缩进错误

      parameters:
        - name: environmentID
          in: query
          description: id from the gamificationenvironment
          required: true
          type: integer
          format: int32
        - name: authorizationToken
          in: query
          description: Authorization token to create a new environment
          required: true
              schema:
                type: object
    --> Error   $ref: '#/definitions/Token'
      responses:
        201:
          description: GamificationID for the Admin
          schema:
            type: object
            items:
              $ref: '#/definitions/Environment'
        default:
          description: Unexpected error
          schema:
              $ref: '#/definitions/Error'

definitions:
  Token:
    required:
      - authentificationKey
      - user
    properties:
      authentificationKey:
        type: string
      senderID:
        type: integer
        format: int32
      user:
        type: string
        type: integer
        format: int64
  Error:
    type: object
    properties:
      code:
        type: integer
        format: int32
      message:
        type: string
      fields:
        type: string

我的问题是： 为什么与$ref 的映射在响应中起作用并且 在参数我得到一个错误？

【问题讨论】：

你确定在 $ref 之前没有标签吗？如果你把那条线换成另一条 $ref 线会发生什么？

我将它与错误中的 $ref 交换，但没有任何成功

【参考方案1】：

这部分语法错误：

         required: true
             schema:
               type: object
               $ref: '#/definitions/Token'

schema: 应与required: 处于同一级别。