AWS API Gateway: Menyelesaikan Kesalahan 403 pada Permintaan OPTIONS Selama Invokasi Lokal SAM

Memahami Kesalahan 403 di AWS API Gateway Lokal

Setelah bekerja dengan Gerbang API AWS dan menguji secara lokal melalui AWS SAM (Model Aplikasi Tanpa Server), biasanya menemukan bug yang tidak muncul setelah API diterapkan. Salah satu masalahnya adalah mendapatkan a 403 Kesalahan terlarang saat menjalankan metode OPTIONS, meskipun API untuk CORS telah dikonfigurasi dengan benar dan AuthorizationType disetel ke "NONE". Masalah ini bisa menjadi sangat memberatkan ketika penyiapan berjalan lancar di lingkungan yang diterapkan.

Saat menguji permintaan OPTIONS secara lokal dengan keriting, API Gateway mungkin mengembalikan kesalahan "Token Otentikasi Hilang". Hal ini membingungkan karena metode OPTIONS seharusnya tidak memerlukan otentikasi, terutama ketika diatur secara tegas untuk memberikan hasil 200. Mengidentifikasi sumber kesenjangan ini sangat penting untuk keberhasilan pembangunan daerah.

Memahami mengapa SAM lokal berperilaku berbeda dari API Gateway yang disebarkan dapat membantu Anda memecahkan masalah ini. Penting untuk mempelajari detail konfigurasi dan memastikan bahwa lingkungan lokal dan lingkungan yang diterapkan sedapat mungkin cocok. Kesalahan konfigurasi sering kali mengakibatkan kesalahan seperti itu.

Pada artikel ini, kita akan melihat kemungkinan penyebab kesalahan 403 selama pengembangan lokal dan cara mengatasinya. Kami akan meninjau kendala umum di dalamnya Templat SAM, penanganan CORS, dan penyiapan API Gateway, sehingga Anda dapat menghindari rintangan ini dan terus membangun secara efektif.

Memahami dan Mengoptimalkan Invokasi Lokal AWS API Gateway

Pada artikel ini, kita akan melihat kemungkinan penyebab kesalahan 403 selama pengembangan lokal dan cara mengatasinya. Kami akan meninjau kendala umum di dalamnya Templat SAM, penanganan CORS, dan penyiapan API Gateway, sehingga Anda dapat menghindari rintangan ini dan terus membangun secara efektif.

Di server Express, kami menggunakan res.setHeader() untuk mengatur header CORS seperti "Access-Control-Allow-Origin" dan "Access-Control-Allow-Methods". Hal ini memastikan bahwa header yang sesuai dikembalikan ke klien, memungkinkan permintaan lintas asal. Selain itu, metode POST skrip terhubung ke tabel AWS DynamoDB melalui AWS SDK. Operasi pemindaian adalah tindakan baca-saja yang mengembalikan semua catatan dari tabel yang dipilih, memungkinkan kita menguji interaksi database secara lokal. Penanganan kesalahan yang tepat digunakan untuk mengelola masalah koneksi database, memastikan bahwa server merespons kegagalan dengan tepat.

Contoh kedua, yang dibuat dengan Python dengan Flask, menyediakan fungsionalitas yang sama dengan skrip Node.js tetapi ditujukan untuk pengembang yang lebih berpengalaman dengan Python. labu aplikasi.rute() metode merutekan metode OPTIONS dan POST ke rutinitas tertentu, memastikan bahwa permintaan preflight CORS ditangani dengan mudah. Respons khusus ditentukan menggunakan aplikasi.response_class() metode, yang mencakup header CORS yang relevan. Metode POST, seperti contoh Node.js, menggunakan AWS SDK for Python (boto3) untuk memindai tabel DynamoDB. Modularitas ini memungkinkan pengembang untuk mengubah backend berdasarkan apakah mereka lebih suka JavaScript atau Python.

Terakhir, pengaturan templat SAM memastikan bahwa AWS API Gateway telah diatur dengan tepat untuk menerima kueri POST dan OPTIONS. Itu Perilaku Passthrough atribut disetel ke "WHEN_NO_MATCH", yang memungkinkan API Gateway menangani permintaan yang tidak cocok dengan templat yang telah ditentukan. Hal ini berguna ketika bekerja dengan integrasi tiruan karena memungkinkan sistem mengirimkan 200 kode status tanpa benar-benar menjalankan backend Lambda. Itu Respons Integrasi Dan MetodeRespons bagian menentukan header dan parameter respons yang memastikan metode OPTIONS mengirimkan konfigurasi CORS yang benar ke klien. Metode ini penting untuk menghindari masalah "403 Terlarang" selama pengujian SAM lokal.

// 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: "'*'"

Pemecahan Masalah Kesalahan 403 Lokal AWS API Gateway

Memahami bagaimana kebijakan CORS (Cross-Origin Resource Sharing) diterapkan di API Gateway sangat penting ketika melihat kesalahan 403 selama pemanggilan lokal SAM. Meskipun penerapan Anda mungkin menangani CORS dengan tepat di cloud, pemanggilan lokal menggunakan AWS SAM terkadang dapat mengakibatkan ketidakcocokan antara cara penanganan metode OPTIONS. Hal ini karena lingkungan lokal mungkin tidak selalu menduplikasi semua pengaturan secara akurat, dan mekanisme OPTIONS harus diintegrasikan dengan benar untuk menghindari kesulitan otentikasi.

Fitur utama lainnya adalah kesalahan 403 sering dikaitkan dengan izin API Gateway yang hilang atau salah dikonfigurasi. Selama pengembangan lokal, penting untuk memastikan bahwa templat SAM Anda didefinisikan dengan tepat Tipe Otorisasi sebagai "TIDAK ADA" untuk permintaan OPSI, dan izin terkait di Lambda fungsi telah diatur dengan benar. Jika tidak, permintaan akan mengembalikan pesan "Token Otentikasi Hilang", yang menunjukkan bahwa sistem mengharapkan mekanisme otentikasi yang tidak ditentukan.

Terakhir, menangani integrasi tiruan adalah teknik yang efisien untuk menghindari persyaratan memanggil fungsi Lambda untuk metode OPTIONS. Buat sebuah Integrasi MOCK dengan parameter respons di API Gateway Anda untuk menjamin metode OPTIONS memberikan respons 200 default dengan header CORS yang diperlukan. Hal ini menyederhanakan proses pengembangan dan membantu menghindari kesalahan 403, yang sering kali disebabkan oleh kueri pra-penerbangan yang tidak dikelola baik di pengaturan lokal maupun yang diterapkan.