代码之家  ›  专栏  ›  技术社区  ›  hiveship

Swagger UI不在模型中显示枚举值

  •  0
  • hiveship  · 技术社区  · 8 年前

    我在使用Swagger UI时遇到了一个小问题,我还不确定这是不是一个bug。。。

    我已经使用Swagger Editor描述了我的API,并且我有一个包含枚举参数的方法。

    现在,问题是:在生成的Swagger UI文档中,在“model”选项卡中,我有一个“messageType”对象的空定义:(我想显示允许的值(BRAND、VISITOR、COMMENT和RESPONSE)

    要重现的代码段:

    swagger: '2.0'
    info:
      version: 1.0.0-SNAPSHOT
      title: foo
      description: foo
    host: dev.fr
    basePath: /base
    schemes:
      - http
      - https
    consumes:
      - application/json
    produces:
      - application/json
    
    paths:
      /social/message:
        post:
          operationId: create
          responses:
            '201':
              schema:
                $ref: '#/definitions/message'
            'default':
              description: Default error response
    
    definitions:
      message:
        required:
          - title
          - messageType
        properties:
          title:
            type: string
          messageType:
            $ref: '#/definitions/messageType'
    
      messageType:
        enum:
          - COMMENT
          - RESPONSE
    

    screen capture

    知道吗?我做错了吗?这是一个bug吗? 非常感谢:)

    1 回复  |  直到 8 年前
        1
  •  1
  •   hiveship    8 年前

    fehguy是对的,通过在我的对象上添加“type:string”解决了这个问题:)