2015-08-06 1 views
1

Я создаю REST API и имеют следующие примеры API:Что такое лучший REST API?/car/{make}/{model}/диск OR/автомобиль/привод/{make}/{model}?

Автомобиль может быть

  • создано
  • удален
  • приводом
  • возвращается как массив моделей для заданного make
  • вернулся как массив всех автомобилей

Какой формат должен использовать API? Это имеет значение?

+0

Я бы, скорее всего, пошел бы с чем-то вроде: '/ cars/{make}/{model}/drive' – David

ответ

3

Предполагая, что drive - это глагол, то вам нужно будет /car/{make}/{model}/drive, потому что вы запрашиваете определенный ресурс для управления. В этом случае вам нужен автомобиль, который составляет {make} и модели {model}. После того, как этот ресурс будет возвращен, вы затем «водите» его.

Второй не имеет смысла, потому что вы указываете глагол, а затем атрибуты для получения ресурса после этого.

Как раз в сторону, если вы стремитесь к чистым стандартам REST, я бы не использовал «диск» как часть API. Ваш REST API должен выполнять действия HTTP, такие как GET, POST, PUT.

+0

Спасибо за напоминание о действиях HTTP и дублировании этого URL. Где будет гипотетический «Драйв»? В моем случае я хочу, чтобы конкретное зашифрованное письмо было подтверждено (подпись) или расшифровано. – LamonteCristo

+1

Вот интересный разговор по нему на SO. Я согласен с принятым ответом: http://stackoverflow.com/questions/11676550/how-to-expose-a-validation-api-in-a-restful-way – sma

Смежные вопросы