Как в DBAPI осуществляется проверка параметров API‑запросов

Практическое руководство

Пример 1 — Проверка длины строкового параметра: не более 4 символов

• В проекте «Проверка параметров» нажмите кнопку добавить правило проверки параметра.

• В поле скрипта проверки укажите JavaScript‑код, например: name.length < 5. В поле сообщения об ошибке задайте соответствующее текстовое сообщение. Если это правило проверки не пройдёт, будет выведено указанное сообщение об ошибке.

Обратите внимание: JavaScript‑код может состоять из нескольких строк; главное, чтобы последняя строка была логическим выражением или логической переменной, а каждая строка завершалась точкой с запятой. Например: var res = name.length < 5; res;

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

• Сохраните API и разверните его.
• Перейдите на страницу тестирования API‑запросов, введите достаточно длинную строку и отправьте запрос. При этом отобразится сообщение об ошибке.

Пример 2 — Проверка нескольких параметров

• Если в API есть несколько параметров, каждый из них можно проверять отдельно.

Нажмите кнопку «Добавить», чтобы создать любое количество правил проверки параметров.

Пример 3 — Взаимная проверка нескольких параметров

Пример 4 — Проверка сложных вложенных JSON‑параметров

• Для API с типом параметра application/json также возможна проверка параметров.

Примечание

• Эта функция доступна только в корпоративной версии; она была внедрена в DBAPI корпоративной версии 4.1.0.