Как отправлять запросы

hashtag Обзор интерфейса

Все примеры показаны с авторизованнымarrow-up-right Swagger

В Swagger основной функциональной единицей является HTTP-запрос, который также называют конечной точкой, ручкой, маршрутом.

В NocoDB запросы группируются по таблицам.

hashtag HTTP-запрос

Чтобы поработать с запросом, нужно его развернуть. Для этого достаточно нажать на него:

hashtag Описание запроса

Каждый запрос имеет описание того, какой функционал он предоставляет.

Оно находится в самом начале:

hashtag Try it out

1

Шаг 1 — Включить режим тестирования

Чтобы начать тестировать запрос, нужно нажать кнопку “Try it out”.

2

Шаг 2 — Проверьте авторизацию

Убедитесь, что “замок закрыт” — это значит, что вы авторизованы. В противном случае, вам следует авторизоваться в Swagger.

3

Шаг 3 — Ввести параметры и выполнить

После нажатия на “Try it out” станут доступными поля ввода параметров и/или тела запроса.

Появится кнопка “Execute”, нажатие которой означает выполнение запроса с введенными параметрами.

hashtag Параметры запроса

Параметры запроса всегда передаются в URL в самом конце после “?” и разделяются “&”, например:

...tables/m6uv6qopcq4layy/records**?limit=25&shuffle=0&offset=0**

Каждый отдельный параметр имеет название:

И описание:

Параметры всегда являются строкой, которую вы можете указать при тестировании в соответствующее поле:

Иногда параметр может быть выбран из ограниченного списка вариантов в Swagger (но в запросе параметр указывается так же, как и другие):

hashtag Шаблон запроса Curl

Можно увидеть только после нажатия “Execute”. Этот шаблон удобно копировать, чтобы использовать в других инструментах разработчиков и тестировщиков ( Curlarrow-up-right, Postmanarrow-up-right ), но для связки с Smartbot Pro и NocoDB он не обязателен.

При этом его удобно использовать в связке с n8n (<и сюда надо ссылку на доку n8n про импорт Curl>)

hashtag Шаблон URL запроса

Можно увидеть только после нажатия “Execute”. Удобное поле, которое позволяет копировать сформированный при тестировании запрос.

hashtag Лайфхак с urlencoded

Обратите внимание, что при запросе в примере передается параметр:

where=%D0%BB%D1%8F%D0%BB%D1%8F%D0%BB%D1%8F

Эти непонятные символы не что иное, как “ляляля”.

На самом деле, не обязательно отправлять запрос в таком формате в блоке “Отправить HTTP-запрос”.

Smartbot Pro автоматически преобразует URL в urlencoded формат.

Для того, чтобы URL в сценариях был более читаем, вы можете преобразовать полученный URL при помощи декодераarrow-up-right.

hashtag Server response

Можно увидеть только после нажатия “Execute”. Показывает всю информацию, полученную из ответа от сервера (API).

Code - код статуса ответаarrow-up-right от сервера.

Response body - тело ответа.

В NocoDB API при любых типах запросов возвращает JSON.

hashtag Responses

В этом разделе изображаются примеры ответов от сервера с различными статусами.

Стоит отметить, что количество примеров не исчерпывающее, обычно ограничивающееся 200 и 400, но эти примеры все равно могут пригодиться для:

• решения сбоев и проблем

• понимания, какой будет ожидаемый ответ от сервера, перед тем, как начать его тестировать.

hashtag Схемы данных

В самом низу Swagger есть раздел Schemas. Он может быть полезен для понимания, какие поля таблицы (столбцы) какого типа данных.

Для примера, поле Id, обязательное при запросах PATCH, PUT, DELETE, а также GET-запросе конкретной строки из таблицы, имеет тип “integer”, что значит, что это именно целое число, а не строка, дробное число или другой тип.