AWS API Gateway: устранение ошибок 403 в запросах OPTIONS во время локального вызова SAM

Понимание ошибок 403 на локальном шлюзе API AWS

После работы с API-шлюз AWS и локальное тестирование с помощью AWS SAM (модель бессерверных приложений), обычно обнаруживаются ошибки, которые не возникают после развертывания API. Одной из проблем является получение 403 Запрещенная ошибка при выполнении метода OPTIONS, несмотря на правильную настройку API для CORS и установку для параметра AuthorizationType значения «NONE». Эта проблема может усугубляться, если установка в развернутой среде проходит гладко.

При локальном тестировании запросов OPTIONS с помощью завиток, шлюз API может вернуть ошибку «Отсутствует токен аутентификации». Это вызывает недоумение, поскольку метод OPTIONS не должен требовать аутентификации, особенно если он явно настроен на получение результата 200. Выявление источника этого неравенства имеет решающее значение для успешного местного развития.

Понимание того, почему локальный SAM ведет себя иначе, чем развернутый шлюз API, может помочь вам устранить эту проблему. Крайне важно углубиться в детали конфигурации и обеспечить максимально возможное соответствие локальной и развернутой сред. Неправильные настройки часто приводят к таким ошибкам.

В этой статье мы рассмотрим вероятные причины ошибки 403 при локальной разработке и способы ее устранения. Мы рассмотрим распространенные ошибки в Шаблоны SAM, обработку CORS и настройки API-шлюза, чтобы вы могли избежать этих препятствий и продолжить эффективную разработку.

Понимание и оптимизация локального вызова шлюза AWS API

В этой статье мы рассмотрим вероятные причины ошибки 403 при локальной разработке и способы ее устранения. Мы рассмотрим распространенные ошибки в Шаблоны SAM, обработку CORS и настройки API-шлюза, чтобы вы могли избежать этих препятствий и продолжить эффективную разработку.

На сервере Express мы используем res.setHeader() чтобы установить заголовки CORS, такие как «Access-Control-Allow-Origin» и «Access-Control-Allow-Methods». Это гарантирует, что клиенту будут возвращены соответствующие заголовки, что позволяет выполнять запросы из разных источников. Кроме того, метод POST сценария подключается к таблице AWS DynamoDB через AWS SDK. Операция сканирования — это действие только для чтения, которое возвращает все записи из выбранной таблицы, что позволяет нам локально тестировать взаимодействие с базой данных. Правильная обработка ошибок используется для управления проблемами подключения к базе данных, обеспечивая правильную реакцию сервера на сбои.

Второй пример, созданный на Python с помощью Flask, предоставляет ту же функциональность, что и сценарий Node.js, но предназначен для разработчиков, имеющих больший опыт работы с Python. Фляга приложение.маршрут() Метод направляет методы OPTIONS и POST указанным подпрограммам, гарантируя, что предварительные запросы CORS будут легко обрабатываться. Пользовательские ответы определяются с помощью app.response_class() метод, который включает соответствующие заголовки CORS. Метод POST, как и пример Node.js, использует AWS SDK для Python (boto3) для сканирования таблицы DynamoDB. Эта модульность позволяет разработчикам просто изменять серверную часть в зависимости от того, предпочитают ли они JavaScript или Python.

Наконец, настройка шаблона SAM гарантирует, что шлюз AWS API правильно настроен для получения запросов POST и OPTIONS. Сквозное поведение Для атрибута установлено значение «WHEN_NO_MATCH», что позволяет шлюзу API обрабатывать запросы, не соответствующие заранее определенному шаблону. Это полезно при работе с макетными интеграциями, поскольку позволяет системе доставлять код состояния 200 без реального запуска серверной Lambda. ИнтеграцияОтветы и МетодОтветы В разделах указаны заголовки и параметры ответа, которые гарантируют, что метод OPTIONS отправляет клиенту правильную конфигурацию CORS. Этот метод имеет решающее значение для предотвращения проблемы «403 Forbidden» во время локальных тестов SAM.

// Import required modules
const express = require('express');
const AWS = require('aws-sdk');
const cors = require('cors');
const app = express();
app.use(cors());
// Middleware for JSON request parsing
app.use(express.json());
// CORS preflight response handling
app.options('/scanRecords', (req, res) => {
  res.setHeader('Access-Control-Allow-Origin', '*');
  res.setHeader('Access-Control-Allow-Methods', 'POST, OPTIONS');
  res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization');
  res.status(200).send();
});
// Main POST method for scanRecords
app.post('/scanRecords', async (req, res) => {
  const dynamoDB = new AWS.DynamoDB.DocumentClient();
  try {
    const params = { TableName: 'RecordsTable' };
    const data = await dynamoDB.scan(params).promise();
    res.status(200).json(data);
  } catch (err) {
    res.status(500).send('Error fetching records');
  }
});
// Start the Express server on PORT 3000
app.listen(3000, () => {
  console.log('Server running on http://localhost:3000');
});

from flask import Flask, jsonify, request
import boto3
app = Flask(__name__)
# CORS headers for OPTIONS requests
@app.route('/scanRecords', methods=['OPTIONS'])
def options_method():
    response = app.response_class(status=200)
    response.headers['Access-Control-Allow-Origin'] = '*'
    response.headers['Access-Control-Allow-Methods'] = 'POST, OPTIONS'
    response.headers['Access-Control-Allow-Headers'] = 'Content-Type, Authorization'
    return response
# POST method to scan records from DynamoDB
@app.route('/scanRecords', methods=['POST'])
def scan_records():
    dynamodb = boto3.resource('dynamodb')
    table = dynamodb.Table('RecordsTable')
    try:
        response = table.scan()
        return jsonify(response['Items']), 200
    except Exception as e:
        return str(e), 500
# Run the Flask app on port 3000
if __name__ == '__main__':
    app.run(debug=True, host='0.0.0.0', port=3000)

Resources:
  scanRecords:
    Type: AWS::Serverless::Function
    Properties:
      Handler: dist/dynamo/CRUD.scanRecords
      CodeUri: ./backend
      Policies:
        - AmazonDynamoDBFullAccess
        - CloudWatchLogsFullAccess
      Events:
        ApiEvent:
          Type: Api
          Properties:
            Path: /scanRecords
            Method: post
  scanRecordsOptionsMethod:
    Type: AWS::ApiGateway::Method
    Properties:
      AuthorizationType: NONE
      HttpMethod: OPTIONS
      ResourceId: !Ref scanRecordsResource
      RestApiId: !Ref apiGatewayRestApi
      Integration:
        Type: MOCK
        IntegrationResponses:
          - StatusCode: 200
            ResponseParameters:
              method.response.header.Access-Control-Allow-Headers: "'Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token'"
              method.response.header.Access-Control-Allow-Methods: "'POST,OPTIONS'"
              method.response.header.Access-Control-Allow-Origin: "'*'"

Устранение неполадок, связанных с локальными ошибками 403 шлюза API AWS

Понимание того, как политики CORS (совместное использование ресурсов между источниками) применяются в шлюзе API, имеет решающее значение при обнаружении ошибки 403 во время локального вызова SAM. Хотя ваше развертывание может соответствующим образом обрабатывать CORS в облаке, локальный вызов с использованием АВС СЭМ иногда может привести к несовместимости обработки метода OPTIONS. Это связано с тем, что локальные среды не всегда могут точно дублировать все настройки, и механизм OPTIONS должен быть правильно интегрирован, чтобы избежать проблем с аутентификацией.

Еще одна ключевая особенность заключается в том, что ошибка 403 часто связана с отсутствием или неправильной настройкой разрешений API-шлюза. Во время локальной разработки очень важно убедиться, что ваш шаблон SAM правильно определяет Тип авторизации как «NONE» для запросов OPTIONS и что соответствующие разрешения в Лямбда функция настроена правильно. В противном случае запрос вернет сообщение «Отсутствует токен аутентификации», указывающее, что система ожидает механизм аутентификации, который не был указан.

Наконец, обработка макетных интеграций — это эффективный метод, позволяющий избежать необходимости вызывать функцию Lambda для метода OPTIONS. Создайте MOCK-интеграция с параметрами ответа в вашем шлюзе API, чтобы гарантировать, что метод OPTIONS доставляет ответ 200 по умолчанию с необходимыми заголовками CORS. Это упрощает процесс разработки и помогает избежать ошибок 403, которые часто возникают из-за неуправляемых предварительных запросов как в локальных, так и в развернутых настройках.