Как правильно добавить действие в rest api отличное от CRUD?

Question

[Тимур]

Не совсем понимаю, как правильно будет с точки зрения архитектуры/дизайна добавить действие в rest api на примере встроенного в Yii2 набора инструментов для создания restful сервиса

Пример: есть контроллер, в котором есть CRUD для создания посылок. С ним все понятно: http get (parcel/index) - список посылок; http post (parcel/create) - создание новой; put (parcel/123) - редактирование существующей и т.д.

Но у меня еще есть метод, который возвращает стоимость посылки на примере заданных параметров не создавая саму посылку. Как быть с ним? Какой тип http запроса к нему отправлять (я думаю post)? На какой url корректно будет слать запрос, если контроллер называется parcel?

Answer 1

[Назар Мокринский]

Заведите отдельный метод, например, calculate. Он не стандартный, но вполне может использоваться и хорошо описывает своё назначение.

Comments

[Тимур]

А какой тип запроса на него нужно слать, чтобы было корректно? Это точно не get, т.к. данных много. Значит post? Я просто первый раз разрабатываю именно restful сервис, и не все идеи мне пока понятны

[Тимур]

И правильно ли я понимаю, что на примере https://github.com/yiisoft/yii2/blob/master/docs/g... мне нужно будет добавлять этот метод в OPTIONS /parcel? Или он не относится к данным, и там не нужен?

[Назар Мокринский]

Тимур: Ещё раз: не get, не post, а calculate. В options я бы добавил, это как-бы самодокументирование. С Yii конкретно не работаю, так что более специфично не подскажу.

[Тимур]

Назар Мокринский: вы сейчас про имя action'a или про http метод? В http нет такого метода https://ru.wikipedia.org/wiki/HTTP#.D0.9C.D0.B5.D1...

[Тимур]

Назар Мокринский: я имею в виду каким http-методом отправлять данные на action в моем случае

[Назар Мокринский]

Тимур: Я же изначально написал что метод (HTTP само собой), и там же написал что его нет в спецификации, и это абсолютно ничего не значит.

[Назар Мокринский]

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

[Тимур]

Спасибо, я даже не знал, что можно делать свои методы. Но все же остановлюсь на get

[Тимур]

Сейчас начинаю понимать преимущества предложенного вами способа. Если я делаю свой метод (например, CALCULATE), то как в таком случае корректно будет передавать параметры? В url (как get) или в теле запроса (как post)? По идее как get, т.к. данные не меняются, но это ведь уже и не get? Хочется передавать как post...

[Назар Мокринский]

Тимур: Поскольку метод кастомный - то как вам угодно.
PHP вам при таком методе данные не распарсит в $_POST автоматически, так что может быть удобнее работать с $_GET (у меня CMS сама такие ситуации обрабатывает, и даже JSON запросы, так что мне проще).
А ещё у вас на сервере ничего не изменяется, то есть последующий аналогичный запрос вернёт такой же результат - а это опять ближе к GET логике.
Так что я бы в URL передавал.

[Тимур]

Назар Мокринский: понял. Большое вам спасибо!

Answer 2

[Талгат Балтасов]

http get запросом отправляете, сколько бы не было данных
get - всегда для получения данных
put - всегда для замены
post - всегда для добавления
delete - для удаления

Comments

[Сергей Протько]

поправка, put не для редактирования а для замены ресурса, для редактирования есть patch.

[Талгат Балтасов]

Сергей Протько: да, ошибся

Answer 3

[Сергей Протько]

Почему бы не так:

GET /prices?from="efaef&to=aeaef&foo=bar

Если делать как предлагает Назар Мокринский, то это RPC, это тоже нормальный подход, когда имена ресурсов не очень ложатся (например я так делаю с методами апишки для восстановления пароля). В этом случае лучше использовать POST, но опять же в вашем случае все все еще нормально ложится на rest, так что....

Answer 4

[vyachin]

я присоединяюсь к ответу Талгат Балтасов немного дополнив. Если в результате запроса состояние вашей системы не меняется - однозначно метод GET. Возможно потребуется добавить новый объект (читай контроллер), калькулятор расчета стоимости посылки и спрашивать у него.

Comments

[Тимур]

Спасибо за пояснение. В голове все встало на свои места