Методы API

Секция Методы API определяет http методы, которые могут быть вызваны из внешних систем или js кода сайта.

В секции Методы API содержится список из элементов, заголовок которых определяет название метода(он будет отображён в описании swagger), например Получить общее количество заявок, Добавить заявку из внешней системы и т.д.

Элемент Метод API

Название	Тип	Описание
Описание	Строка	Используется в описании swagger.
Url	Строка, относительный путь	По этому пути можно будет делать http запрос.
Тип запроса	GET/POST	Тип http запроса.
Не показывать в swagger	Нет/Да	При значении Да метод не будет отображаться в swagger.
Python код	Путь до python файла	При вызове метода будет вызван этот код.
Параметры	Массив объектов Параметр API метода	Параметры метода.

Элемент Параметр API метода

Параметры метода будут извлечены из запроса и переданы в Python код.

Название параметра задаёт под каким идентификатором он будет извлечен из запроса.

Название	Тип	Описание
Тип данных	Строка/Число	Параметр будет извлечен из запроса и провалидирован в соответствии с этим типом.
Источник	Из строки запроса/Из адреса запроса/Из тела запроса	Определяет метод извлечения параметра.

Пример app.rms

app.rms (Фрагмент)

Методы API:
  - Получить общее количество заявок:
    Описание: Получить общее количество активных заявок на данный момент
    Url: /api/requestsCount
    Тип запроса: GET
    Python код: scripts/get_requests_count.py
  - Добавить заявку из внешней системы:
    Описание: Создание заявки из внешней системы
    Url: /api/createRequest
    Тип запроса: POST
    Не показывать в swagger: Да
    Параметры:
      - title:
        Тип данных: Строка
        Источник: Из тела запроса
      - text:
        Тип данных: Строка
        Источник: Из тела запроса
    Python код: scripts/create_request.py