Шлюз AWS API: вирішення помилок 403 у запитах OPTIONS під час локального виклику SAM

Розуміння помилок 403 на локальному шлюзі API AWS

Після роботи з Шлюз API AWS і локальне тестування за допомогою AWS SAM (безсерверна модель додатків), зазвичай виявляють помилки, які не виникають після розгортання API. Однією з проблем є отримання a 403 Заборонена помилка під час виконання методу OPTIONS, незважаючи на належне налаштування API для CORS і налаштування AuthorizationType на "NONE". Ця проблема може бути особливо серйозною, якщо інсталяція в розгорнутому середовищі проходить гладко.

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

Розуміння того, чому SAM local поводиться інакше, ніж розгорнутий шлюз API, може допомогти вам вирішити цю проблему. Дуже важливо вникнути в деталі конфігурації та переконатися, що локальне та розгорнуте середовища максимально збігаються. Неправильне налаштування часто призводить до таких помилок.

У цій статті ми розглянемо ймовірні причини помилки 403 під час локальної розробки та способи її усунення. Ми розглянемо типові підводні камені в Шаблони SAM, керування CORS і налаштування шлюзу API, щоб ви могли уникнути цих перешкод і продовжувати ефективне будівництво.

Розуміння та оптимізація локального виклику шлюзу AWS API

У цій статті ми розглянемо ймовірні причини помилки 403 під час локальної розробки та способи її усунення. Ми розглянемо типові підводні камені в Шаблони SAM, керування CORS і налаштування шлюзу API, щоб ви могли уникнути цих перешкод і продовжувати ефективне будівництво.

У експрес-сервері ми використовуємо res.setHeader() щоб установити заголовки CORS, наприклад «Access-Control-Allow-Origin» і «Access-Control-Allow-Methods». Це гарантує, що відповідні заголовки повертаються клієнту, дозволяючи перехресні запити. Крім того, метод POST сценарію підключається до таблиці AWS DynamoDB через AWS SDK. Операція сканування — це дія лише для читання, яка повертає всі записи з вибраної таблиці, що дозволяє перевірити взаємодію з базою даних локально. Належна обробка помилок використовується для керування проблемами з’єднання з базою даних, гарантуючи належну реакцію сервера на збої.

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

Нарешті, налаштування шаблону SAM гарантує, що шлюз AWS API належним чином налаштовано для отримання запитів POST і OPTIONS. The PassthroughBehavior для атрибута встановлено значення "WHEN_NO_MATCH", що дозволяє шлюзу API обробляти запити, які не відповідають попередньо визначеному шаблону. Це корисно під час роботи з фіктивними інтеграціями, оскільки дозволяє системі надавати код стану 200 без справжнього запуску бекенда Lambda. The IntegrationResponses і MethodResponses розділи визначають заголовки та параметри відповіді, які гарантують, що метод 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 AWS API Gateway

Розуміння того, як політики CORS (Cross-Origin Resource Sharing) застосовуються в шлюзі API, має вирішальне значення, коли ви бачите помилку 403 під час локального виклику SAM. Хоча ваше розгортання може належним чином обробляти CORS у хмарі, використовуючи локальний виклик AWS SAM іноді може призвести до несумісності між тим, як обробляється метод OPTIONS. Це пояснюється тим, що локальні середовища не завжди можуть точно дублювати всі налаштування, і механізм OPTIONS має бути належним чином інтегрований, щоб уникнути труднощів автентифікації.

Ще одна ключова особливість полягає в тому, що помилка 403 часто пов’язана з відсутніми або неправильно налаштованими дозволами API Gateway. Під час локальної розробки дуже важливо переконатися, що ваш шаблон SAM правильно визначає AuthorizationType як "NONE" для запитів OPTIONS і що відповідні дозволи в Лямбда функція налаштована належним чином. В іншому випадку запит поверне повідомлення «Відсутній маркер автентифікації», яке вказує на те, що система очікує механізм автентифікації, який не було зазначено.

Нарешті, обробка фіктивних інтеграцій є ефективним методом, щоб уникнути вимоги виклику функції Lambda для методу OPTIONS. Створіть a Інтеграція MOCK з параметрами відповіді у вашому шлюзі API, щоб гарантувати, що метод OPTIONS надає відповідь 200 за умовчанням із потрібними заголовками CORS. Це спрощує процес розробки та допомагає уникнути помилок 403, які часто спричинені некерованими запитами перед друком як у локальних, так і в розгорнутих налаштуваннях.