Инструмент для ограничений типа для REST в AWS Lambda (или JavaScript в целом)

На чтение 3 мин Опубликовано 09.01.2025

Содержание

Вопрос или проблема
Ответ или решение
Решение задачи
Пример использования AJV для решения задачи
Заключение

Вопрос или проблема

Я хочу создать REST API в AWS Lambda с использованием JavaScript, но у меня есть проблема. В отличие от Django Rest, здесь нет готового REST интерфейса, который позволяет задавать точные типы и ограничения для размещаемых JSON объектов.
Допустим, я хочу иметь конечную точку для заказов, где заказы имеют следующие ограничения:

{
    product:[действительный productID в виде строки],
    amount: [количество предметов от 1 до 1000],
    customer: [будет автоматически заполняться системой, не является частью post-запроса],
    comment: [строка от 0 до 1000 символов или null],
    status: ["ожидает оплаты", "в обработке", "отправлено", "завершено", будет также заполняться системой и не является частью post-запроса],
    id:[автоматически]
}

Как я могу установить такие ограничения для элементов в JavaScript?

Это можно сделать, проверив полезные данные на соответствие JSON Schema. Библиотека для этого в JavaScript — AJV.

Ответ или решение

Создание REST API в AWS Lambda с использованием JavaScript требует внимательного подхода к валидации и контролю типов передаваемых данных. В данном контексте возникает вопрос о реализации точных ограничений типов и структуры JSON-объектов, аналогично тому, как это реализовано в Django REST Framework.

Решение задачи

Для эффективного управления типами и ограничениями JSON-объектов в JavaScript можно воспользоваться библиотекой AJV (Another JSON Validator), которая позволяет валидировать данные на основе JSON Schema. Это предоставляет мощный и гибкий способ указания допустимых форматов и значений, что особенно полезно в случае обработки сложных запросов к API.

Пример использования AJV для решения задачи

Установка и настройка AJV: Для начала необходимо установить библиотеку AJV через npm:
```
npm install ajv
```
Создание JSON Schema: Определим схему валидации, соответствующую требованиям вашего REST API:
```
{
 "type": "object",
 "properties": {
   "product": { "type": "string" },
   "amount": { "type": "integer", "minimum": 1, "maximum": 1000 },
   "comment": { "type": ["string", "null"], "maxLength": 1000 }
 },
 "required": ["product", "amount"],
 "additionalProperties": false
}
```
В этой схеме указываются типы данных и ограничения: строка для product, число в диапазоне от 1 до 1000 для amount, строка или null для comment.

Имплементация в AWS Lambda: В функции AWS Lambda можно использовать AJV для валидации входящих данных:

const Ajv = require("ajv");
const ajv = new Ajv();
const schema = {
 type: "object",
 properties: {
   product: { type: "string" },
   amount: { type: "integer", minimum: 1, maximum: 1000 },
   comment: { type: ["string", "null"], maxLength: 1000 }
 },
 required: ["product", "amount"],
 additionalProperties: false
};

const validate = ajv.compile(schema);

exports.handler = async (event) => {
 const data = JSON.parse(event.body);

 const valid = validate(data);
 if (!valid) {
   return {
     statusCode: 400,
     body: JSON.stringify({ errors: validate.errors }),
   };
 }

 // Дальнейшая обработка валидных данных

 return {
   statusCode: 200,
   body: JSON.stringify({ message: "Data processed successfully" }),
 };
};

Заключение

Использование JSON Schema и библиотеки AJV в AWS Lambda позволяет жёстко контролировать и управлять типами ваших данных. Это не только улучшает безопасность и надёжность API, но и помогает избежать ошибок, связанных с неверными данными. Подход с использованием AJV в JavaScript является мощным инструментом для создания сложных и точных REST API.