Aglio не позволяет определять параметры в теле как параметры

Question

Aglio, рендер рендеринга API, не позволяет включить параметры в тело запроса в разделе параметров спецификации конечной точки. Он бросает синтаксический предупреждение следующим образом:

parameter '<some_parameter>' not specified in '<some_description>' its '<some_URI_template>' URI template (warning code 8)

Образец уценки, который бы повторить это предупреждение является:

## Journey creation [/v1/journeys/{origin}] 

### Create journey [POST] 
Create a new journey 

+ Parameters 
    + origin (required) ... origin location of journey 
    + destination (required) ... destination location of journey 

+ Request 
    + Headers 

       Accept: application/json 
       Authorization: Basic <BASIC_AUTH_TOKEN> 

    + Body 

       { 
        "destination" : "some_other_place" 
       } 


+ Response 200 (application/json) 

    + Body 

      { 
      "origin" : "some_place", 
      "destination" : "some_other_place", 
      "journey_state" : "Not_Started", 
      "timestamp" : "<dateuuid>", 
      } 

Визуализированное не нравится «назначения», чтобы быть параметром, так как он не в шаблоне URI.

Мой вопрос в том, является ли это недостатком инструмента, или это особый дизайн API Blueprint? Возможно, это определение конечной точки REST не для стандартов?

Answer 1

Правильный способ указания атрибутов тела сообщения использует новый синтаксис атрибута MSON, который используется для визуализации схемы JSON и JSON с Aglio 2.0.

### Create journey [POST] 
Create a new journey 

+ Parameters 
    + origin (required) - origin location of journey 

+ Attributes 
    + destination: some_other_place (required) - destination location of journey 

+ Request 
    + Headers 

       Accept: application/json 
       Authorization: Basic 

В ближайшее время Aglio предоставит дополнительную информацию об атрибутах.