Как правильно работать с REST API?

Question

[Sergey Filnor]

Доброй ночи.
Сейчас работаю над одинм проектом с достаточно опытным программистом и судя по всему не совсем понимаю коцепцию REST API и как с ним нужно работать.
Я пишу фронтэнд приложения на react и взаимодействую c данными через API.
Например ситуация.
У меня есть сложный обьект который мне нужно обновить или добавить. Под сложным подразумеваю примерно следующее: (это обьект написаный только что на коленке чисто для демо, в реальном у меня под 40 полей и 5 уровней вложености)

var Obj = {
  client: {
    id: "1442",
    address: {
      legal_address:{ id: "532", zip: "48202", country: "USA", street: "Apple str", house: "10", office: "25"},
      post_address: { id: "533", zip: "48202", country: "USA", street: "Apple str", house: "12", office: "25"}
   },
    stocks: [
       {
         id: "25",
         title: "Sunday Stock",
         address: { id: "532", zip: "48202", country: "USA", street: "Apple str", house: "10", office: "25"}
       },
       {
         id: "27",
         title: "Monday Stock",
         address: { id: "532", zip: "48202", country: "USA", street: "Apple str", house: "10", office: "25"}
       }
    ]
  }
}

При этом в базе это все храниться примерно так:

id         post_address    legal_address    stocks
1442       532             533              25;27

Самое главное, на сервере стоит валидация обьекта и я должен передавать туда не id, как оно хранится в базе, а полный обьект типа того который я показал выше на примере.
И самое сложное начинается когда нужно добавить новый обьект, например в массив складов.
Сейчас у меня это работает вот так:

api.newObj('stock', stockData).then( ( newStockId ) => {
       // Получаю полный обьект клиента на текущее состояние 
       api.getObj('client', id).then( ( clientObj ) => {
           // Получаю полный обьект склада что бы добавить его к массиву существующих складов
           api.getObj('stock', newStockId ).then( (newStockObj) => {
             // Добавляю к массиву складов
              var StockArray = newStockObj.stocks;
                    StockArray.push( newStockObj );
              var UpdateObj = Object.assign({}, clientObj, {stocks: StockArray});
              // Обновляю клиента
              api.updateObj('client', UpdateObj);
           });
       });
    });

Это все работает, но выглядит как-то костыльно и не совсем логично.
Но иначе, я не смогу отдать серверу валидные данные. Особенно это сложно, когда я добавляю обьект у которого внутри вложено еще 2-3 обьекта со своими id, которые так же добавляются когда приходят в запросе на добавление нового обьекта. (Например со складом, это обьект адресса который пишется в отдельную табличку).

Как делать правильно?

Answer 1

[Николай]

Ну вообще днище какое-то.
Для добавления таких привязанных к объекту сущностей обычно делают PATCH/PUT запрос с урлом типа /:resource_name/:resource_id/:entity_name.
В вашем случае что-то типа PUT /clients/:id/stocks

Comments

[Sergey Filnor]

Ну собственно по этому и спрашиваю, что бы с днища этого выбираться.
Сам понимаю, что такой подход это лютый трешак.

Мои подозрения, на то что мы в проекте работаем с rest апи очень преувеличенно - оправдались) Я отправяю на определенные урл (get/update/delete/create) просто обьект с данными и никакие связи при этом не апдейтятся, все приходится делать вручную при этом ловится куча багов.
Приходится работать с тем что дают, к сожалению на бек энд разработчика повлиять не могу :(

[vsuhachev]

Sergey Filnor, на самом деле не все так однозначно

Например, если вы API используете на медленном клиенте (смартфон по 3G например) то на каждый новый запрос растут накладные расходы протокола HTTP (коннект, хэндшэйк, пердача хэдеров и т.п.) и собирнием все вподряд в один запрос обычно пытаются этого избежать.

Понятно что все хорошо без фанатизма и нужно искать баланс..

ЗЫ: Кстати, а вы знаете про normalizr?

[Николай]

vsuhachev, по поводу отправки целого объекта - тогда надо отправлять минимально необходимое для всех связных сущностей(обычно id) достаточно. В чем смысл делать так, как у автора - я не понимаю.

[Sergey Filnor]

vsuhachev, Про normalizr не знал, вот читаю доки.
Правильно ли улавливаю суть, что я могу входящие данные перевести в стандартизированый вариант который буду использовать в приложении. А при отправке назад их денормализировать в исходный вид?

Я сейчас не вижу особых приемуществ в этом + какие нужны будут ресурсы(время) что бы интегрировать такую штуку в проект.
Если можете, обьясните чем мне это поможет? Для меня это пока как-то не очевидно, + с учетом того что все мои скрипты сейчас заточены по тот формат данных который у меня есть, страшно представить обьемы по внедрению такой технологии

[vsuhachev]

Sergey Filnor, вы все верно уловили. В существующий проект внедрять наверное смысла нет, если это затратно, тем более что функционал разборки/сборки сложного объекта у вас уже написан.

Вообще я так спросил, знаете ли вы про эту библиотеку т.к. сам его использую для таких вот сложных объектов.

[vsuhachev]

Николай, неизвестно по какому критерию оптимизировали API. Если по понятности для человеков, то никакие ссылки через id там фигурировать не должны (ну или должны по минимуму).

Answer 2

[Сергей Сунцев]

Может я что то могу не так понять, но в чем проблема получить этот сложный объект с сервера со всеми полями, и его же(модифицированный) отправлять на сервер, к примеру:

const {data} = this.props
data.phones.value[position] = newValue
this.props.onSubmit(data)

т.е. получаем данные с сервера

модифицируем

и отправляем каким то методом обратно, но уже новые

Comments

[Sergey Filnor]

Проблема в том, что я не могу добавить новый обьект таким образом, а update у меня так и работает.
Для создания, получается что нужно вначале сделать запрос на добавление данных, получить id нового обьекта, потом запрос на обновление родителя где хранится привязка дочерних элементов и потом еще обновить обьект на вьюхе отдельным запросом.
Я код уже немного оптимизировал и сократил до трех запросов с четырех. Запрос на получение только что записаного склада в БД был излишним. Сейчас я просто к обьету который я передаю, добовляю поле id которое мне приходит в промисе.

[Sergey Filnor]

Ну, а кроме того сложность в том, что у меня этот обьект разбит на много подобьектов, каждый из которых обновляется отдельно.
т.е если у меня в складе есть поле address которое являтся отдельным обьектом типа address, то и обновлять я должен обьект адресса, а не глобально обновить всего клиента ¯\_(ツ)_/¯

[vsuhachev]

Sergey Filnor, если все так, то похоже проблема у вашего бэка. Вообще стандартный способ создания чего либо это POST на url коллекции, в ответ вам выдают 201 и хэдер Location со ссылкой на вновь созданный объект. Ну или сам объект с заполнеными id, но это не всегда оптимально по трафику...