首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >如何在API蓝图(MSON)中引用枚举值

如何在API蓝图(MSON)中引用枚举值
EN

Stack Overflow用户
提问于 2019-01-17 09:41:38
回答 1查看 3.4K关注 0票数 5

我使用API蓝图阿吉洛来呈现API文档。当使用枚举类型时,我观察到一种奇怪的行为。响应不是用定义的枚举值显示的,而模式显示的是所有枚举值(这是预期的)以及声明的值(“星期一”--参考实际值)。

数据结构部分

代码语言:javascript
复制
# Data Structures

## Days (enum[string])
+ `Monday`
+ `Tuesday`
+ `Wednesday`
+ `Thursday`

## ListEntry
- playOrder: 1 (number)
- Id: 37a21975a499494f03367 (string)
- programDay: `Tuesday` (Days)

## `sample-request-200`
- id: 58828b2941cc351348 (string)
- startDate: `2019-08-01T11:00:00.000Z` (string)
- endDate: `2019-08-05T11:55:59.000Z` (string)
- Language: `en-US` (string)
- entries: ListEntry (array[object])

API请求文档部分

代码语言:javascript
复制
+ Request
+ Headers

        Content-Type: application/json

+ Attributes (sample-request-200)

实际

代码语言:javascript
复制
---- JSON Body ----  

    {
      "playOrder": 1,
      "Id": "37a21975a499494f03367",
      "programDay": "Hello, world!" // Agilo shows "Hello,World" when some error occurred
    }

-----Generated Schema-----  

"programDay": {
              "type": "string",
              "enum": [
                "Monday",
                "Tuesday",
                "Wednesday",
                "Thursday",
                "Monday"
              ]
            }

期望的

代码语言:javascript
复制
 ---- JSON Body ----
    {
      "playOrder": 1,
      "Id": "37a21975a499494f03367",
      "programDay": "Monday"
    }


-----Generated Schema-----  

"programDay": {
              "type": "string",
              "enum": [
                "Monday",
                "Tuesday",
                "Wednesday",
                "Thursday"
              ]
            }

任何关于如何在API蓝图(MSON)中使用定义的枚举数据结构的想法。不确定如何引用对象中的枚举值。

下面使用引用枚举值是正确的吗?

代码语言:javascript
复制
- programDay: `Tuesday` (Days)
EN

回答 1

Stack Overflow用户

发布于 2019-05-09 03:55:20

结构:

代码语言:javascript
复制
# Data Structures
## Device (enum)
+ `mobile`
+ `desktop`

像这样使用:

代码语言:javascript
复制
+ Request (multipart/form-data)
    + Attributes
        + `id`: abc (required)
        + `device` (Device)

结果:

票数 4
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/54232977

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档