AWS API நுழைவாயில்: SAM

Daniel Marino

செவ்வாய், 24 செப்டம்பர், 2024 ’அன்று’ முற்பகல் 4:53:19

உள்ளூர் AWS API கேட்வேயில் 403 பிழைகளைப் புரிந்துகொள்வது

உடன் பணிபுரிந்த பிறகு AWS API நுழைவாயில் மற்றும் AWS SAM (சர்வர்லெஸ் அப்ளிகேஷன் மாடல்) மூலம் உள்நாட்டில் சோதனை செய்வது, API பயன்படுத்தப்பட்ட பிறகு எழாத பிழைகளைக் கண்டறிவது வழக்கம். ஒரு சிக்கல் a பெறுவது 403 தடைசெய்யப்பட்ட பிழை CORS க்கான API ஐ சரியாக உள்ளமைத்து, அங்கீகார வகையை "NONE" என அமைத்தாலும், OPTIONS முறையை இயக்கும் போது. வரிசைப்படுத்தப்பட்ட சூழலில் அமைவு சீராக இயங்கும்போது இந்தச் சிக்கல் குறிப்பாக மோசமாகலாம்.

உடன் உள்ளூரில் OPTIONS கோரிக்கைகளை சோதிக்கும் போது சுருட்டு, API கேட்வே "காணாமல் போன அங்கீகார டோக்கன்" பிழையை வழங்கக்கூடும். இது குழப்பமாக உள்ளது, ஏனெனில் OPTIONS முறைக்கு அங்கீகாரம் தேவையில்லை, குறிப்பாக 200 முடிவை வழங்குவதற்கு வெளிப்படையாக அமைக்கப்படும் போது. வெற்றிகரமான உள்ளூர் வளர்ச்சிக்கு இந்த ஏற்றத்தாழ்வின் மூலத்தைக் கண்டறிவது மிகவும் முக்கியமானது.

பயன்படுத்தப்பட்ட API கேட்வேயை விட SAM லோக்கல் ஏன் வித்தியாசமாக செயல்படுகிறது என்பதைப் புரிந்துகொள்வது இந்தச் சிக்கலைச் சரிசெய்ய உதவும். உள்ளமைவு விவரங்களை ஆராய்ந்து, உள்ளூர் மற்றும் வரிசைப்படுத்தப்பட்ட சூழல்கள் ஏறக்குறைய சாத்தியமான அளவுக்கு பொருந்துவதை உறுதிசெய்வது மிகவும் முக்கியமானது. தவறான கட்டமைப்புகள் அடிக்கடி இத்தகைய பிழைகளை ஏற்படுத்துகின்றன.

இந்த கட்டுரையில், உள்ளூர் வளர்ச்சியின் போது 403 பிழைக்கான சாத்தியமான காரணங்கள் மற்றும் அதை எவ்வாறு நிவர்த்தி செய்வது என்பதைப் பார்ப்போம். பொதுவான குறைபாடுகளை மதிப்பாய்வு செய்வோம் SAM வார்ப்புருக்கள், CORS கையாளுதல் மற்றும் API கேட்வே அமைப்புகள், எனவே நீங்கள் இந்த தடைகளைத் தவிர்த்து, திறம்பட உருவாக்குவதைத் தொடரலாம்.

கட்டளை	பயன்பாட்டின் உதாரணம்
app.options()	Express.js இல் OPTIONS கோரிக்கைகளைக் கையாளுவதற்கான வழியை வரையறுக்கிறது, இது ப்ரீஃப்லைட் CORS கையாளுதலுக்குத் தேவைப்படுகிறது. இந்த நிலையில், POST கோரிக்கையைத் தொடர்வதற்கு முன், CORS ப்ரீஃப்லைட் வினவல்களுக்குச் சேவையகம் செயல்பட உதவுகிறது.
res.setHeader()	இந்த செயல்பாடு குறிப்பிட்ட HTTP தலைப்புகளை பதிலில் அமைக்கிறது Access-Control-Allow-Origin, CORS ஐ இயக்குவதற்கும், பல்வேறு மூலங்களிலிருந்து APIகளைப் பயன்படுத்தும் போது 403 பிழைகளைத் தடுப்பதற்கும் முக்கியமானவை.
PassthroughBehavior	AWS API கேட்வே முறைகளுக்கான தனிப்பயன் உள்ளமைவு, பொருந்தக்கூடிய டெம்ப்ளேட் கிடைக்காதபோது கோரிக்கைகளை எவ்வாறு கையாள்வது என்பதைக் குறிப்பிடுகிறது. அதை அமைக்கிறது WHEN_NO_MATCH குறிப்பிட்ட கோரிக்கை டெம்ப்ளேட் வழங்கப்படாதபோது, போலி ஒருங்கிணைப்பு சரியாகச் செயல்படும் என்று உத்தரவாதம் அளிக்கிறது.
IntegrationHttpMethod	பின்தள சேவையை அழைக்க API கேட்வே பயன்படுத்தும் HTTP முறையை வரையறுக்கிறது (எ.கா., Lambda செயல்பாடு). API கேட்வே வழியை பொருத்தமான HTTP முறையுடன் இணைப்பதில் இது மிகவும் முக்கியமானது, இது பின்தளச் செயலைத் தொடங்கும்.
AWS::ApiGateway::Method	AWS SAM டெம்ப்ளேட் API கேட்வே முறை ஆதாரத்தைக் குறிப்பிடுகிறது. API கேட்வே ஆதரிக்க வேண்டிய HTTP முறைகளை (POST, OPTIONS) வரையறுப்பதற்கும், பின்தள ஒருங்கிணைப்புகளுக்கு மேப்பிங் செய்வதற்கும் இது மிகவும் முக்கியமானது.
ResponseParameters	போன்ற தலைப்புகளை அமைப்பதன் மூலம் CORS ஆதரவை இயக்க இந்த கட்டளை API கேட்வே ஒருங்கிணைப்பு பதில்களில் பயன்படுத்தப்படுகிறது அணுகல்-கட்டுப்பாடு-அனுமதி-முறைகள். CORS கொள்கையின்படி இந்த அளவுருக்கள் வாடிக்கையாளருக்குத் திருப்பியளிக்கப்படும்.
app.route()	இந்த Flask கட்டளையானது HTTP முறைகளை (POST மற்றும் OPTIONS போன்றவை) குறிப்பிட்ட செயல்பாடுகளுக்கு வரைபடமாக்குகிறது. இந்த நிலையில், OPTIONS (preflight வினவல்கள்) மற்றும் POST (முக்கிய API கோரிக்கைகள்) ஆகியவற்றிற்கு வித்தியாசமாக செயல்படுவது மிகவும் முக்கியமானது.
!Ref	AWS CloudFormation/SAM டெம்ப்ளேட்களில் பயன்படுத்தப்படுகிறது! Ref டெம்ப்ளேட்டில் உள்ள பிற ஆதாரங்களுக்கான குறிப்புகள். உதாரணமாக, இது குறிப்பிடுவதற்குப் பயன்படுத்தப்படுகிறது scanRecordsResource மற்றும் API அழைப்புகளை சரியான URL உடன் சரியாக இணைக்கவும்.
app.response_class()	இந்தக் கட்டளையானது பிளாஸ்கில் தனிப்பயன் மறுமொழி பொருளை உருவாக்குகிறது, இது HTTP நிலைக் குறியீடுகள் மற்றும் தலைப்புகளின் மீதான கட்டுப்பாட்டை உங்களுக்கு வழங்குகிறது. சில CORS தலைப்புகளை அமைப்பதற்கு இது மிகவும் எளிது Access-Control-Allow-Origin.

AWS API கேட்வே உள்ளூர் அழைப்பைப் புரிந்துகொண்டு மேம்படுத்துதல்

எக்ஸ்பிரஸ் சர்வரில், நாங்கள் பயன்படுத்துகிறோம் res.setHeader() "Access-Control-Allow-Origin" மற்றும் "Access-Control-Allow-Methods" போன்ற CORS தலைப்புகளை அமைக்க. இது பொருத்தமான தலைப்புகள் கிளையண்டிற்குத் திரும்புவதை உறுதிசெய்கிறது, இது குறுக்கு மூலக் கோரிக்கைகளை அனுமதிக்கிறது. கூடுதலாக, ஸ்கிரிப்ட்டின் POST முறை AWS SDK வழியாக AWS DynamoDB அட்டவணையுடன் இணைக்கிறது. ஸ்கேன் செயல்பாடானது, தேர்ந்தெடுக்கப்பட்ட அட்டவணையில் இருந்து அனைத்து பதிவுகளையும் திரும்பப் பெறும் ஒரு படிக்க-மட்டும் செயலாகும், இது தரவுத்தள தொடர்புகளை உள்நாட்டில் சோதிக்க அனுமதிக்கிறது. தரவுத்தள இணைப்பு சிக்கல்களை நிர்வகிக்க சரியான பிழை கையாளுதல் பயன்படுத்தப்படுகிறது, தோல்விகளுக்கு சேவையகம் சரியாக பதிலளிக்கிறது.

Python உடன் Flask இல் கட்டமைக்கப்பட்ட இரண்டாவது எடுத்துக்காட்டு, Node.js ஸ்கிரிப்ட் போன்ற அதே செயல்பாட்டை வழங்குகிறது, ஆனால் இது பைத்தானில் அனுபவம் வாய்ந்த டெவலப்பர்களுக்காக வடிவமைக்கப்பட்டுள்ளது. பிளாஸ்க் தான் app.route() CORS ப்ரீஃப்லைட் கோரிக்கைகள் எளிதாகக் கையாளப்படுவதை உறுதிசெய்து, குறிப்பிட்ட நடைமுறைகளுக்கு, OPTIONS மற்றும் POST முறைகள் இரண்டையும் முறை வழி செய்கிறது. தனிப்பயன் பதில்கள் இதைப் பயன்படுத்தி வரையறுக்கப்படுகின்றன app.response_class() முறை, இதில் தொடர்புடைய CORS தலைப்புகள் அடங்கும். POST முறை, Node.js உதாரணம் போன்றது, DynamoDB அட்டவணையை ஸ்கேன் செய்ய பைத்தானுக்கு (boto3) AWS SDK ஐப் பயன்படுத்துகிறது. இந்த மாடுலாரிட்டி டெவலப்பர்கள் ஜாவாஸ்கிரிப்ட் அல்லது பைத்தானை விரும்புகிறார்களா என்பதை அடிப்படையாகக் கொண்டு பின்தளத்தை மாற்ற அனுமதிக்கிறது.

இறுதியாக, SAM டெம்ப்ளேட் அமைவு AWS API கேட்வே POST மற்றும் OPTIONS வினவல்களைப் பெற சரியான முறையில் அமைக்கப்பட்டுள்ளதை உறுதி செய்கிறது. தி பாஸ்த்ரூ பிஹேவியர் பண்புக்கூறு "WHEN_NO_MATCH" க்கு அமைக்கப்பட்டுள்ளது, இது முன்னரே தீர்மானிக்கப்பட்ட டெம்ப்ளேட்டுடன் பொருந்தாத கோரிக்கைகளைக் கையாள API கேட்வேயை அனுமதிக்கிறது. போலி ஒருங்கிணைப்புகளுடன் பணிபுரியும் போது இது பயனுள்ளதாக இருக்கும், ஏனெனில் இது பின்தளத்தில் Lambda ஐ இயக்காமல் 200 நிலைக் குறியீட்டை வழங்க கணினியை அனுமதிக்கிறது. தி ஒருங்கிணைப்பு பதில்கள் மற்றும் முறை பதில்கள் பிரிவுகள் தலைப்புகள் மற்றும் பதில் அளவுருக்களைக் குறிப்பிடுகின்றன, அவை OPTIONS முறை கிளையண்டிற்கு சரியான CORS உள்ளமைவை அனுப்புவதை உறுதி செய்கிறது. உள்ளூர் SAM சோதனைகளின் போது "403 தடைசெய்யப்பட்ட" சிக்கலைத் தவிர்ப்பதற்கு இந்த முறை முக்கியமானது.

உள்ளூர் SAM அழைப்பிற்காக AWS API கேட்வேயில் 403 பிழைகளைச் சரிசெய்தல்.

தீர்வு 1: Express.js மற்றும் AWS SDK ஐப் பயன்படுத்தி ஒரு Node.js பின்தளம், திறமையான CORS மற்றும் OPTIONS கையாளுதலுடன்.

// 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');
});

AWS SAM லோக்கலில் "காணாமல் போன அங்கீகார டோக்கனை" தீர்க்கிறது

தீர்வு 2: பிளாஸ்குடன் ஒரு பைதான் பின்தளம், உள்ளூர் SAM மற்றும் API கேட்வே மூலம் கட்டமைக்கப்பட்டது

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)

SAM உடன் AWS API கேட்வே உள்ளூர் அழைப்பைச் சோதிக்கிறது

தீர்வு 3: OPTIONS கோரிக்கைகளைக் கையாளவும் 403 பிழைகளைத் தவிர்க்கவும் SAM டெம்ப்ளேட்டை உள்ளமைக்கவும்.

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

AWS API கேட்வே லோக்கல் 403 பிழைகளைச் சரிசெய்தல்

SAM உள்ளூர் அழைப்பின் போது 403 பிழையைப் பார்க்கும்போது, API கேட்வேயில் CORS (கிராஸ்-ஆரிஜின் ரிசோர்ஸ் ஷேரிங்) கொள்கைகள் எவ்வாறு செயல்படுத்தப்படுகின்றன என்பதைப் புரிந்துகொள்வது மிகவும் முக்கியமானது. உங்கள் வரிசைப்படுத்தல் மேகக்கணியில் CORS ஐ சரியான முறையில் கையாளும் போது, உள்ளூர் அழைப்பைப் பயன்படுத்துகிறது AWS SAM சில சமயங்களில் OPTIONS முறை எவ்வாறு கையாளப்படுகிறது என்பதற்கு இடையே இணக்கமின்மையை ஏற்படுத்தலாம். ஏனென்றால், உள்ளூர் சூழல்கள் எப்போதும் எல்லா அமைப்புகளையும் துல்லியமாக நகலெடுக்காது, மேலும் அங்கீகாரச் சிக்கல்களைத் தவிர்க்க விருப்பங்கள் இயக்க முறைமை சரியாக ஒருங்கிணைக்கப்பட வேண்டும்.

மற்றொரு முக்கிய அம்சம் என்னவென்றால், 403 பிழை அடிக்கடி காணாமல் போன அல்லது தவறாக உள்ளமைக்கப்பட்ட API கேட்வே அனுமதிகளுடன் தொடர்புடையது. உள்ளூர் மேம்பாட்டின் போது, உங்கள் SAM டெம்ப்ளேட் சரியான முறையில் வரையறுக்கப்பட்டுள்ளதா என்பதை உறுதிப்படுத்துவது மிகவும் முக்கியமானது அங்கீகார வகை OPTIONS கோரிக்கைகளுக்கு "NONE" ஆகவும், அதனுடன் தொடர்புடைய அனுமதிகள் லாம்ப்டா செயல்பாடு சரியாக அமைக்கப்பட்டுள்ளது. இல்லையெனில், கோரிக்கையானது "காணாமல் போன அங்கீகார டோக்கன்" செய்தியை வழங்கும், இது குறிப்பிடப்படாத அங்கீகார பொறிமுறையை கணினி எதிர்பார்க்கிறது என்பதைக் குறிக்கிறது.

இறுதியாக, OPTIONS முறைக்கு Lambda செயல்பாட்டை அழைக்க வேண்டிய தேவையைத் தவிர்ப்பதற்கு போலி ஒருங்கிணைப்புகளைக் கையாள்வது ஒரு திறமையான நுட்பமாகும். உருவாக்கு a MOCK ஒருங்கிணைப்பு உங்கள் API கேட்வேயில் உள்ள பதில் அளவுருக்களுடன், OPTIONS முறையானது, தேவையான CORS தலைப்புகளுடன் இயல்புநிலை 200 பதிலை வழங்குகிறது. இது டெவலப்மெண்ட் செயல்முறையை எளிதாக்குகிறது மற்றும் 403 பிழைகளைத் தவிர்க்க உதவுகிறது, அவை உள்ளூர் மற்றும் பயன்படுத்தப்பட்ட அமைப்புகளில் நிர்வகிக்கப்படாத ப்ரீஃப்லைட் வினவல்களால் அடிக்கடி ஏற்படுகின்றன.

AWS API கேட்வே 403 பிழைகள் பற்றிய பொதுவான கேள்விகள்

SAM லோக்கலில் மட்டும் 403 சிக்கலை நான் ஏன் பெறுகிறேன், ஆனால் பயன்படுத்தப்படும்போது இல்லை?
உள்ளூர் SAM சூழல் முழுமையான API கேட்வே உள்ளமைவைப் பிரதிபலிக்காது, குறிப்பாக AuthorizationType மற்றும் CORS அமைப்புகள். OPTIONS கோரிக்கைகளுக்கான போலி ஒருங்கிணைப்புகள் உட்பட, பயன்படுத்தப்பட்ட அமைப்புகளுடன் உங்கள் உள்ளூர் அமைப்பு பொருந்துகிறது என்பதை உறுதிப்படுத்தவும்.
"காணாமல் போன அங்கீகார டோக்கன்" பிழை என்றால் என்ன?
API கேட்வே ஒரு அங்கீகார டோக்கனை விரும்புகிறது, அது வழங்கப்படவில்லை என்பதை இந்தப் பிழை குறிக்கிறது. OPTIONS கோரிக்கைகளுக்கு, அதை உறுதிப்படுத்தவும் AuthorizationType: NONE உங்கள் SAM டெம்ப்ளேட்டில் சரியாக உள்ளமைக்கப்பட்டுள்ளது.
AWS API கேட்வேயில் CORS ப்ரீஃப்லைட் கோரிக்கைகளை எவ்வாறு கையாள்வது?
CORS ஐக் கையாள, உங்கள் OPTIONS முறை போன்ற தொடர்புடைய பதில் தலைப்புகளுடன் சரியான முறையில் அமைக்கப்பட்டுள்ளது Access-Control-Allow-Origin மற்றும் Access-Control-Allow-Methods.
AWS SAM மூலம் CORS ஐ உள்நாட்டில் சோதிக்க முடியுமா?
ஆம், நீங்கள் CORS ஐ உள்நாட்டில் சோதிக்கலாம், ஆனால் உங்களுடையதை உறுதிப்படுத்திக் கொள்ளுங்கள் app.options() முறை அல்லது அதற்கு இணையான ஏபிஐ கேட்வே உள்ளமைவு ப்ரீஃப்லைட் OPTIONS கோரிக்கைக்கான சரியான தலைப்புகளை வழங்குகிறது.
AWS API கேட்வேயில் போலி ஒருங்கிணைப்பு என்றால் என்ன?
ஏ MOCK integration பின்தளத்தில் Lambda செயல்பாட்டைப் பயன்படுத்தாமல், API கேட்வேயில் இருந்து நிலையான பதில்களை வழங்க உங்களை அனுமதிக்கிறது, விருப்பங்களின் கோரிக்கைகளுக்கான CORS கையாளுதலை எளிதாக்குகிறது.

AWS API கேட்வே 403 பிழைகளை சரிசெய்வதற்கான இறுதி எண்ணங்கள்

உள்ளூர் SAM சூழல்களில் OPTIONS கோரிக்கைகளுக்கான 403 பிழைகளைச் சரிசெய்ய, உங்கள் SAM வார்ப்புருக்கள் மற்றும் அனுமதிகள் சரியாக கட்டமைக்கப்பட்டுள்ளன. உங்கள் உள்ளூர் சூழலை நீங்கள் பயன்படுத்திய AWS உள்ளமைவுடன் முடிந்தவரை பொருத்துவது மிகவும் முக்கியமானது.

விடுபட்ட டோக்கன் சிக்கல்களைத் தடுக்க, அங்கீகார வகையை "NONE" என மாற்றவும், மேலும் CORS வினவல்களுக்கு முன்பதிவு செய்ய போலி ஒருங்கிணைப்புகளைப் பயன்படுத்தவும். இந்த அமைப்புகளின் கவலைகளை நிவர்த்தி செய்வது மென்மையான உள்ளூர் வளர்ச்சி மற்றும் சரியான API கேட்வே நடத்தைக்கு அனுமதிக்கிறது.

AWS API கேட்வே 403 பிழைகளுக்கான பயனுள்ள ஆதாரங்கள் மற்றும் குறிப்புகள்

CORS வினவல்களைக் கையாள்வதில் கவனம் செலுத்துவதன் மூலம் AWS SAM CLI மற்றும் API கேட்வே லோக்கல் டெவலப்மென்ட்டில் விரிவடைகிறது. அதிகாரப்பூர்வ AWS ஆவணங்கள் விரிவான நுண்ணறிவு மற்றும் எடுத்துக்காட்டுகளை வழங்குகிறது. வருகை: AWS SAM CLI ஆவணங்கள்.
403 தடைசெய்யப்பட்ட பிழைகள் மற்றும் விடுபட்ட அங்கீகார டோக்கன்கள் போன்ற API கேட்வே சிக்கல்களுக்கான விரிவான சரிசெய்தல் தகவலை வழங்குகிறது. பார்க்க: .AWS API கேட்வே பிழை கையாளுதல்.
API கேட்வே மற்றும் லாம்ப்டா செயல்பாடுகளில் CORS ஐ உள்ளமைப்பதற்கான முழுமையான வழிகாட்டி. CORS சிக்கல்கள் உள்ளூர் சோதனையின் போது 403 பிழைகளின் பொதுவான ஆதாரமாகும். மேலும் தகவல் இங்கே: AWS அறிவு மையம்.

AWS API நுழைவாயில்: SAM உள்ளூர் அழைப்பின் போது விருப்பங்கள் கோரிக்கைகளில் 403 பிழைகளைத் தீர்ப்பது