带有int值的Swagger枚举

时间:2015-12-01 10:00:52

标签: c# json enums swagger

我想生成一个包含枚举的swagger-json。我的问题是枚举的呈现方式:

"MyEnumType": {
  "typeName": "MyEnumType",
  "type": "string",
  "enum": [
    "first",
    "second",
    "third"
  ]
}

我真正想要的是可能值的名称(第一,第二,第三)以及枚举值(0,1,2)背后的值。是否有可能生成这样的json(“swagger-valid”),如果是这样,怎么样?

2 个答案:

答案 0 :(得分:3)

我使用NSwag,与此同时,NSwag的Rico Suter提供了该功能。给他很大的道具!

答案 1 :(得分:1)

当前版本的OpenAPI(fka.Swagger)不建议这样做。 它可能会在下一个版本中添加(参见https://github.com/OAI/OpenAPI-Specification/issues/348

同时遇到同样的问题,我结束了在属性描述中提供这些信息。