Тип массива параметров запроса в raml (0.8) в муле

Я получаю один запрос Get, в котором у меня есть тип массива параметров запроса, как показано ниже.

https://localhost:8082/myapi/fetchids?ids=[1,2,3,4]

Теперь я должен определить этот параметр запроса массива в raml, но до сих пор не получил решения.

Мой raml выглядит так, как показано ниже, пожалуйста, посоветуйте, что мне нужно написать для параметра запроса типа массива в версии 0.8.

/fetchdetails:
  get:
   queryParameters:
       Ids:
        description: 'ids'
        type: integer
        required: true
        displayName: Ids

person Isranis    schedule 07.08.2017    source источник


Ответы (2)


В RAML 0.8 нет типа массива.

Вы можете использовать массив на RAML 1 в качестве типа параметра запроса.

Например:

/fetchdetails:
  get:
   queryParameters:
       ids:
        description: 'ids'
        type: integer[]
        required: true

что является сокращением:

/fetchdetails:
  get:
   queryParameters:
       ids:
        description: 'ids'
        type: array 
        items: integer
        required: true
person Pedro    schedule 07.08.2017

Кристиан Фогель в ответ на похожий вопрос , я думаю, на форуме сообщества RAML было сказано: «... вы не можете. Разрешены следующие типы: строка, число, целое число, файл, дата или логическое значение. Что вы можете сделать, это [использовать] строку и в вашем описании скажите, что это список через запятую для людей, обнаруживших ваш API».

person catpaws    schedule 07.08.2017
comment
вы говорите таким образом /fetchdetails: get: queryParameters: ids: description: 'id' type: String [ ] required: true - person Isranis; 09.08.2017
comment
я не хотел подразумевать синтаксис массива в ... смог бы сделать это [использовать] a, но цитировал именно то, что было сказано на форуме, за исключением слова use, которое я вставил, как указано в скобках. Я думаю, вам нужно использовать строковый тип в RAML и документировать для пользователей, как вводить список, разделенный запятыми. Имеет ли это смысл? - person catpaws; 11.08.2017