¶ Создание и настройка API для разных моделей через модуль openapi/swagger/rest api
¶ Установка
- В первую очередь нужно зайти в Odoo Store и скачать модуль https://apps.odoo.com/apps/modules/14.0/openapi/#installation
- Скачанные файлы будут заархивированы, поэтому их нужно разархивировать и разместить в папке addons в репозитории с установленным Odoo. Если нет возможности разархивации на сервере, то можно разместить папку с файлами в гитлабе через локальное устройство, затем на удалённом сервере вытянуть эти файлы с помощью git clone
Коренная папка установленного Odoo
- После размещения репозитория с файлами в папке addons, нужно авторизоваться в одоо под админский аккаунтом и обновить список приложений Apps → Update Apps List, после этого OpenAPI появится в списке модулей
¶ Как настроить
Для настройки api для какой-либо модели нужно в модуле open api нажать кнопку create. Появится такое окно:
В Log requests и Log responses указываем, какие логи хотим получить на сервере с Одоо для запросов и ответов от апи.
Дальше нажимаем Add Line в разделе Accessable Models, появляется следующее окно:
Здесь нужно указать, для какой модели мы хотим настроить api и отметить птичками желаемый функционал.
Чтобы Responses не были пустыми, нужно обязательно добавить в Read One fields и Read Many fields, какие данные мы хотим получать в ответе на запрос одной сущности и всех сущностей соответственно
Нажимаем Create and Edit
В Export id нужно вписать названия полей нужной модели, которые необходимо получать при запросе. Список доступных полей модели можно посмотреть через Settings → Technical → Models → Нужная модель. Добавить собственные поля к модели можно там же.
Затем нужно сохранить изменения и нажать на ссылку Specification link. Будет получена такая подобная спецификация для апи:
Весь этот текст можно скопировать и вставить, например, в editor.swagger.io для получения красиво оформленного swagger
Для всех запросов авторизация Basic, токен можно получить войдя от имени администратора:
Settings → Users & Companies → Users → Аккаунт админа → Allowed integrations → Open API token
Последнее изменение:
Азизбек Пардаев @aapardaev_1
March 9, 2022, 2:31 AM
Над этой страницей работали: Азизбек Пардаев @aapardaev_1