Исходный код вики Методы API
Последние авторы
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="lead" %) | ||
| 2 | Вопросы, связанные с работой методов API: | ||
| 3 | |||
| 4 | * {{showhide showmessage="Почему в ответах некоторых методов API возвращается свойство $type?" hidemessage="Почему в ответах некоторых методов API возвращается свойство $type?"}}|(% style="border-color:white" %)((( | ||
| 5 | (% class="box infomessage" %) | ||
| 6 | ((( | ||
| 7 | **Примечание:** рекомендуется ознакомиться {{html}}<a href="https://docs.loymax.net/xwiki/bin/view/Main/General_information/Used_technologies/">со стеком технологий</a>{{/html}}, используемых системой Loymax. | ||
| 8 | ))) | ||
| 9 | |||
| 10 | ((( | ||
| 11 | Объекты, используемые во фреймворке **.Net**, переводятся из структуры данных в последовательность байтов или строку. В таком формате данные удобно передавать и хранить. | ||
| 12 | |||
| 13 | (% class="box" %) | ||
| 14 | ((( | ||
| 15 | Процесс перевода состояния объекта в поток байтов с целью их сохранения в памяти ПК, в базе данных или файле называется **сериализацией**. Основное назначение сериализации — сохранение состояния объекта, чтобы в случае необходимости была возможность восстановить его. | ||
| 16 | Обратный перевод байтов в структуру данных называется **десериализцией**. | ||
| 17 | ))) | ||
| 18 | |||
| 19 | Система Loymax для сериализации/десериализации использует сериализатор **Newtonsoft.Json.JsonSerializer**. | ||
| 20 | ))) | ||
| 21 | )))|(% style="border-color:white; text-align:center; width:25%" %){{lightbox image="Group 1 (1).png"/}} | ||
| 22 | |||
| 23 | Рассмотрим процесс сериализации/десериализации на примере работы метода для {{html}}<a href="https://docs.loymax.net/xwiki/bin/view/Main/Integration/Ways_to_use_API/API_methods/Methods_of_public_api/Brands/#H41F43E43B44344743543D43843544143F43844143A43043144043543D43443E432">получения списка брендов</a>{{/html}}. | ||
| 24 | |||
| 25 | Все бренды в Системе созданы по одному шаблону (модели), то есть наследуются от одного типа данных. | ||
| 26 | |||
| 27 | Например: | ||
| 28 | |||
| 29 | * Существует тип **BrandBase**. | ||
| 30 | * Пользователь создал бренды: **Brand1 **и **Brand2**. | ||
| 31 | * **Brand1 **и **Brand2 **наследуют все свойства типа **BrandBase**. | ||
| 32 | * Так как бренды являются объектами .Net, они переводятся в поток байтов для хранения в базе данных. | ||
| 33 | |||
| 34 | Алгоритм получения информации о брендах через методы API работает следующим образом: | ||
| 35 | |||
| 36 | 1. Клиент отправляет запрос на получение списка брендов (##GET: /v1.2/brands##). | ||
| 37 | 1. Сервер обрабатывает запрос, формирует и отправляет SQL-запрос в базу данных на получение списка брендов. | ||
| 38 | 1. База данных в ответ на запрос сервера возвращает серверу список брендов, которые переводятся из потока байтов обратно в объект .Net. | ||
| 39 | 1. Сервер возвращает клиенту список брендов в формате JSON: | ||
| 40 | 1*. Сериализатор **Newtonsoft.Json.JsonSerializer **преобразует объект .Net в формат JSON. | ||
| 41 | 1*. **Brand1 **и **Brand2 **являются объектами, созданными по типу **BrandBase**. Так как сериализатор ожидает получить только объект типа **BrandBase**, а **Brand1 **и **Brand2 **распознает как отдельные типы, которые наследуются от общего типа **BrandBase**, то он присваивает им свойство ##$type##, в котором указана модель, согласно которой был создан объект, чтобы при десериализации создать объект исходного типа. | ||
| 42 | |||
| 43 | Таким образом, в ответе на запрос для получения списка брендов, информация о **Brand1 **будет выглядеть следующим образом: | ||
| 44 | |||
| 45 | (% class="box" %) | ||
| 46 | ((( | ||
| 47 | ##{ | ||
| 48 | "$type": "Loymax.Api.Models.BrandInfo.BrandBase, Loymax.Api", | ||
| 49 | "id": 111222, | ||
| 50 | "guid": "00000000-0000-0000-0000-000000000000", | ||
| 51 | "code": "7878b563333841d79a5e5d14fde29cbe", | ||
| 52 | "order": 0, | ||
| 53 | "state": "Normal", | ||
| 54 | "uid": "10e6c953-132d-441b-8ecb-1525b2d06e10", | ||
| 55 | "name": "Brand1", | ||
| 56 | "description": "Новый бренд", | ||
| 57 | "fullDescription": null, | ||
| 58 | "url": null, | ||
| 59 | "images": [] | ||
| 60 | }## | ||
| 61 | ))){{/showhide}} |