Apiary.io различные ответы, не зависящие от кодов состояния

Question

Я пытался создать макет API с помощью apiary.io. Раздел моего текущего плана 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. Но так как пасека использует коды состояния для дифференциации ответов, я вынужден использовать коды состояния 202 и 203. Есть ли способ, которым я мог бы избежать этого?

Я думал о функциональности, с помощью которой он будет давать разные ответы, основанные на разных параметрах. Но похоже, что эта функциональность все еще выполняется (Apiary.io - multiple responses (200) with different parameters).

Есть ли способ обозначить схему следующим образом?

+ 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 действительно БОЛЬШОЙ.

Answer 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, 
     }