RAML资源接受多个枚举

时间:2018-11-12 10:36:35

标签: rest api-design raml

我具有定义为details的{​​{1}}特质

enums

当我查询使用此特征details: queryParams: detail: type: string enum: [small, big, categories, box] 的端点时,我收到API验证错误。

如何定义example.com/api?detail=small,big,以便我可以查询enumexample.com/api?detail=smallexample.com/api?detail=small,big,依此类推。

1 个答案:

答案 0 :(得分:0)

对于该用例,您可以使用特征来传递允许值的字段列表,如下所示:

#%RAML 1.0
---
title: test
baseUri: https://mocksvc.qax.mulesoft.com/mocks/73ff2db5-abbf-4cad-aab1-80f6da9d6055
version: v2
protocols: [ HTTP ]
mediaType: application/json

traits:
  sparsable:
    queryParameters:
      detail?:
        type: string
        pattern: (<<fieldset>>),?

/api:
  displayName: api
  get:
    is: [ sparsable: { fieldset: small|big|categories|box } ]

荣誉:https://medium.com/raml-api/arrays-in-query-params-33189628fa68