example-pattern.json

{
  "title": "API Gateway REST API with Lambda proxy integration and CORS enabled",
  "description": "API Gateway REST API with Lambda proxy integration which is responsible for returning the Access-Control-Allow-Origin and Access-Control-Allow-Headers headers",
  "language": "Python",
  "level": "200",
  "framework": "AWS SAM",
  "introBox": {
    "headline": "How it works",
    "text": [
      "A REST API is created that has a GET method with a Lambda integration where API Gateway returns the CORS headers",
      "The API also has an OPTIONS method with a Lambda proxy integration where the backend Lambda function returns the CORS headers"
    ]
  },
  "gitHub": {
    "template": {
      "repoURL": "https://github.com/aws-samples/serverless-patterns/tree/main/apigw-cors-proxy",
      "templateURL": "serverless-patterns/apigw-cors-proxy",
      "projectFolder": "apigw-cors-proxy",
      "templateFile": "apigw-cors-proxy/template.yaml"
    }
  },
  "resources": {
    "bullets": [
      {
        "text": "Enabling CORS for a REST API resource",
        "link": "https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-cors.html"
      },
      {
        "text": "Testing CORS",
        "link": "https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-test-cors.html"
      }
    ]
  },
  "deploy": {
    "text": [
      "sam deploy"
    ]
  },
  "testing": {
    "text": [
      "See the GitHub repo for detailed testing instructions."
    ]
  },
  "cleanup": {
    "text": [
      "Delete the stack: <code>cdk delete</code>."
    ]
  },
  "authors": [
    {
      "name": "Noor Bari",
      "image": "https://media.licdn.com/dms/image/D4D03AQF-Eqdxb5EgDg/profile-displayphoto-shrink_800_800/0/1681412120461?e=1687392000&v=beta&t=4PQGZ9dxklC2oRdf_vdJxQH6UNkmqWScVMga9H4C3Qw",
      "bio": "Cloud Support Engineer @ AWS",
      "linkedin": "https://www.linkedin.com/in/noor-bari-521251206/"
    }
  ]
}