【问题标题】:I want to know can i give name to enum declared in Swagger?我想知道我可以给在 Swagger 中声明的枚举命名吗?
【发布时间】:2017-12-24 14:12:18
【问题描述】:

我有一个像下面这样的枚举

enum:
 - Male
 - Female

但在内部我希望这是FM?就像如果我打印 Male 它应该打印 M not male

【问题讨论】:

  • 想想拳头,你会如何将 ENUM 传递给你的 API?
  • 在 api 中我也希望值为 M 但对于前端我希望它为男性
  • 你不认为是一个字符串吗?

标签: swagger swagger-editor swagger-codegen


【解决方案1】:

由于您在 cmets 中谈到前端,我猜您的意思是当您显示此值时,您希望显示“女性”和“男性”,而不是 F 和 M,这部分超出了 swagger 的作用。

您现在需要输入的是 API 期望接收的值,正如您所说,M 和 F。

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

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

如何在前端显示数据是完全不同的事情,你应该实现一些东西来显示枚举值,但你认为是最好的。

在 swagger 规范中有几个关于枚举的问题与您想要的有点相关:herehere

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2015-06-10
    • 2021-11-10
    • 1970-01-01
    • 2012-03-06
    • 1970-01-01
    • 2010-12-28
    • 1970-01-01
    相关资源
    最近更新 更多