我想知道我可以给Swagger中声明的枚举命名吗?

时间:2017-07-19 10:48:13

标签: swagger swagger-editor swagger-codegen

我有一个类似下面的枚举

enum:
 - Male
 - Female

但在内部我想要FM?就像我打印男性它应该打印M而不是男性

1 个答案:

答案 0 :(得分:0)

因为在你的评论中你谈到了前端,我想你的意思是,当你展示这个价值观时,你想要展示"女性"和#34;男性"而不是F和M,这部分超出了招摇的范围。

您现在需要提供的是API期望接收的值,如您所述,M和F.

properties:
  gender:
    type: string
    description: Gender of the person
    enum:
    - M
    - F

考虑data types listed in the spec您的最佳选择似乎是string

如何在前端显示数据是一个完全不同的问题,你应该实现一些东西来显示枚举值,但你决定最好。

在swagger规范中有一些问题涉及与你想要的内容有关的枚举:herehere