Apiary.io不同的响应,不依赖于状态代码

时间:2016-06-15 08:15:07

标签: apiblueprint apiary.io

我尝试使用enter image description here创建API模拟。我目前的API蓝图的一部分如下所示。

+ Request (application/json)

    {
        "key": "secret",
    }

+ Response 200 (application/json)

    {
        "decision_type" : 1,
    }

+ Response 202 (application/json)

    {
        "decision_type" : 2,
    }

+ Response 203 (application/json)

    {
        "decision_type" : 3,
    }

根据提供给我的API文档,理想情况应该是在所有三种情况下返回的响应状态应为200。但由于养蜂场使用状态代码来区分回复,因此我不得不使用202203状态代码。有什么方法可以避免这种情况吗?

我想到了一种功能,它可以根据不同的参数给出不同的响应。但似乎此功能仍在实施(apiary.io)。

有没有办法表示如下的蓝图?

+ Response 200 (application/json) type=1

    {
        "decision_type" : 1,
    }

+ Response 200 (application/json) type=2

    {
        "decision_type" : 2,
    }

+ Response 200 (application/json) type=3

    {
        "decision_type" : 3,
    }

type调用期间可以将此REST作为标题进行访问。

我将被迫关闭养蜂场并转移到其他应用程序以生成模拟,这将意味着大量的工作,因为我的API真的很大。

1 个答案:

答案 0 :(得分:1)

API mock将始终在您的文档中提供第一个响应。如果您只想将它​​用于模拟,您可以尝试这样的事情:

## Get Decision type 1 [/?type=1]

### decision type [GET]


+ Response 200 (application/json) 

        {
            "decision_type" : 1,
        }

## Get Decision type 2 [/?type=2]

### decision type [GET]


+ Response 200 (application/json) 

        {
            "decision_type" : 2,
        }

## Get Decision type 3 [/?type=3]

### decision type [GET]


+ Response 200 (application/json) 

        {
            "decision_type" : 3,
        }