2016-02-18 9 views
1

Я пишу документацию по API и получил проблемы.Есть ли способ отправить пустые необязательные параметры запроса?

Вот определение ссылка:

### Get hotels availability [GET /agent/v1/hotel/availability{?regions,hotels,from,to,limit,offset}] 

Параметры:

+ Parameters 
    + regions (required,string,`399,189`) 
    + hotels (optional, string, `1844`) 
    + from (optional, string, `2016-03-12`) 
    + to (optional, string, `2016-03-19`) 
    + limit (optional, number, `1`) 
    + offset (optional, number, `0`) 

Когда я пытаюсь отправить запрос с пустым hotels параметра, например, пасека использует 1844 вместо пустой. Если я попытаюсь проигнорировать его, то будет отправлен hotels=hotels.

Есть ли способ отправить пустой для необязательного параметра или вообще не отправить его?

Вот ссылка с скриншоте: http://www.awesomescreenshot.com/image/1008356/09614be501945b0644fd84a06e311404

ответ

5

Я не уверен, понимаю ли я вашу проблему правильно. Я попытался воспроизвести описанное вами поведение. Я создал новый API проект в Пасеке и написал следующий API Blueprint:

FORMAT: 1A 

# Hotels API 

# Group Hotels 

## Hotels [/agent/v1/hotel/availability{?regions,hotels,from,to,limit,offset}] 

+ Parameters 
    + regions (required,string,`399,189`) 
    + hotels (optional, string, `1844`) 
    + from (optional, string, `2016-03-12`) 
    + to (optional, string, `2016-03-19`) 
    + limit (optional, number, `1`) 
    + offset (optional, number, `0`) 

### Get hotels availability [GET] 

+ Response 200 (application/json) 

     {"hello":"world"} 

Затем я открыл консоль панели в генерируемой интерактивной документации и попытался изменить параметры URL:

editing URL parameters

URL-адрес в верхняя часть меняется правильно. Я сделал некоторые запросы с консолью и на странице Traffic Inspector, кажется, подтверждают, что правильные параметры были отправлено:

enter image description here

Я думаю, вы должны уточнить свой вопрос и предоставить более подробную информацию. Кроме того, я считаю, что это довольно специфическая тема для Apiary, и может быть больше смысла связываться с поддержкой Apiary в [email protected]. Если электронная почта не ваша вещь, есть также интерактивный чат:

enter image description here


Отказ от ответственности: На момент написания ответа я работаю Пасека.

+0

Благодарим за отзыв. Пробовал дома - http://goo.gl/4xsX2Q, поэтому он не зависит от браузера. Во всяком случае использование '0' вместо ценности работает, так что это не большая сделка. – ineersa

+0

@ineersa, это действительно странно. Мы пытались воспроизвести это в Apiary на двух разных компьютерах, но все же безуспешно. Ваш «скринкаст» явно доказывает, что он нарушен для вас, и я хотел бы знать, почему. Не возражаете связаться с нашей поддержкой, чтобы мы могли получить более подробную информацию от вас, пожалуйста? Если электронная почта не ваша вещь, я собираюсь обновить свой ответ с инструкциями, как попасть в наш интерактивный чат. Я бы очень хотел, чтобы это было исправлено для вас! –