RAML - 建模查询婴儿车之间的依赖关系

时间:2014-12-15 17:14:36

标签: raml

我正在使用RAML为API建模,我想知道是否可以在查询参数之间建模依赖关系。

假设我们有一组对象。用户可以通过指定对象类型和状态来缩小查询结果的范围。这里有一些RAML应该按照我刚才所说的做法:

/objects:
  - searchable:
    queryParameters: 
        object-type:
            enum: [Type1, Type2, Type3]
        object-state:
            enum: [State1, State2, State3]

现在上面的定义可能会让用户觉得可以使用他们想要的任何组合 - 这是不对的,因为:
- ' Type1'的对象可以采取只是' State1',
- ' Type2'的对象可以采取' State2'和' State3',
- ' Type3'的对象可以采取State1',' State2',' State3'。

有没有人知道如何使用RAML进行建模?

1 个答案:

答案 0 :(得分:0)

AFAIK在RAML中无法实现。 RAML旨在描述一个API,它更倾向于成为业务逻辑。

尽管如此,我已经从很多人那里听说过这个问题,我认为可以在RAML 1.0

中对待它。

干杯!