2016-05-31 12 views
0

Ich bin vor ein kleines Problem mit Swagger UI und ich bin noch nicht sicher, wheter ist es ein Bug oder nicht ...Swagger UI nicht Enum-Werte in Modellen angezeigt

ich meine API beschrieben habe mit Swagger Editor und ich habe eine Methode, die einen enum-Parameter enthält.

Nun, das Problem: In der Swagger-UI-Dokumentation erzeugt, in der Registerkarte 'Modell' habe ich eine leere Definition des Objekts 'messageType' :(Ich möchte die zulässigen Werte anzeigen (BRAND, BESUCHER, COMMENT und RESPONSE)

ein Code-Schnipsel zu reproduzieren:?

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

Jede Idee, ich tue es falsch Ist es ein Fehler Vielen dank :)

?
+2

Ihr 'messageType' deklariert nicht als' type'. 'enum' ist kein gültiger Typ im JSON-Schema. Erwägen Sie, "type: string" als Geschwister zur Enumeration hinzuzufügen. – fehguy

+0

Du bist ritght! Vielen Dank :) – hiveship

Antwort

0

Fehguy ist richtig, Problem gelöst durch Hinzufügen von "type: string" zu meinem Objekt :)