2013-07-08 56 views
3

如何把這個類進行建模Swagger正確解讀呢?揚鞭API文檔 - 型號列表<Enum>

public myEnum { 
    alpha, 
    bravo, 
    charlie 
} 

public class myClass { 
    public List<myEnum> myList { get; set; } 
} 

我不能簡單地這樣做:

{ 
    "myClass": { 
     "id": "myClass", 
     "properties": { 
      "myList": { 
       "type": "string", //??? it isn't a string, it's a List... 
       "allowableValues": { 
        "valueType": "LIST", 
        "values": [ 
         "alpha", 
         "bravo", 
         "charlie" 
        ] 
       } 
      } 
     } 
    } 
} 

,這沒有任何意義之一:

{ 
    "myEnum": { 
     "id": "myEnum", 
     "properties": { 
      //??? there aren't any... 
     } 
    }, 
    "myClass": { 
     "id": "myClass", 
     "properties": { 
      "myList": { 
       "type": "List", 
       "items": { 
        "$ref": "myEnum" 
       } 
      } 
     } 
    } 
} 

回答

0

遇到this post in the Swagger Google Group,這使我這個答案:

{ 
    "myClass": { 
     "id": "myClass", 
     "properties": { 
      "myList": { 
       "type": "List", 
       "items": { 
        "type": "string" 
       }, 
       "allowableValues": { 
        "valueType": "LIST", 
        "values": [ 
         "alpha", 
         "bravo", 
         "charlie" 
        ] 
       } 
      } 
     } 
    } 
}