Create API Gateway (GET)

Tổng quan

This section guides you through creating a REST API named GetInvoiceAPI with routes for querying and updating invoice data. Each route is connected to a Lambda function and has CORS enabled, then deployed with a dev stage.

Step 1: Create REST API

1. Sign in to the AWS Management Console, search for and open API Gateway.

2. Click Create an API.

3. Select REST API, then click Build.

4. Configure the following:

   • API name: GetInvoiceAPI
   • Description: Post Invoice File by API Gateway
   • Endpoint Type: Select Regional.

5. Click Create API to finish.

Step 2: Create Resources & Methods

Resource: /invoice

1. In GetInvoiceAPI, choose Create resource.

2. Enter:

   • Resource path: /
   • Resource name: invoice

3. Click Create resource.

4. After creating /invoice, select it in the resource tree.

5. Click Create method.

6. Configure in Create method:

   • Method type: GET.
   • Integration type: Lambda function.
   • Lambda proxy integration: Enabled.
   • Lambda function: FetchInvoiceDetailsFunction.

7. Click Create method.

8. The API Gateway will be created and redirected to the API Gateway details configuration page.

Resource: /invoice/{id}

1. In the resource tree, select the /invoice resource.

2. In the resource tree, select the /invoice resource.

3. Enter the following:

   • Resource path: /invoice/
   • Resource name: {id}

4. Click Create resource.

5. After the /invoice/{id} resource is created, select it again in the resource tree.

6. Click Create method.

7. Configure the Create method section:

   • Method type: GET.
   • Integration type: Lambda function.
   • Lambda proxy integration: Enabled.
   • Lambda function: FetchInvoiceDetailsFunction.

8. Click Create method.

9. Proceed to add a PATCH method.

   • Select the resource in the tree and click Create method again.

- Configure similarly:

    - **Method type**: PATCH
    - **Integration type**: Lambda Function
    - **Use Lambda Proxy integration**: Enabled
    - **Lambda Function**: FetchInvoiceDetailsFunction

10. Click Create method.

Resource: /invoice/starred

1. In the GetInvoiceAPI, select the /invoice resource.

2. Click Create resource.

3. Configure:

   • Resource path: /invoice/
   • Resource name: starred

4. Click Create resource.

5. After the resource is created, select /invoice/starred in the tree.

6. Click Create method.

7. Configure the Create method:

   • Method type: GET.
   • Integration type: Lambda function.
   • Lambda proxy integration: Enabled.
   • Lambda function: FetchInvoiceDetailsFunction.

8. Click Create method.

Resource: /invoice/starred/{id}

1. In GetInvoiceAPI, select /invoice/starred.

2. Click Create resource.

3. Configure:

   • Resource path: /invoice/starred/
   • Resource name: {id}

4. Click Create resource.

5. After the resource is created, select /invoice/starred/{id}.
6. Click Create method.

7. Configure the Create method:

   • Method type: PATCH.
   • Integration type: Lambda function.
   • Lambda proxy integration: Enabled.
   • Lambda function: FetchInvoiceDetailsFunction.

8. Click Create method.

Resource: /invoice/tags

1. In GetInvoiceAPI, select /invoice.

2. Click Create resource.

3. Configure:

   • Resource path: /invoice/
   • Resource name: tags

4. Click Create resource.

Resource: /invoice/tags/{id}

1. In the resource tree, select /invoice/tags.
2. Click Create resource.

3. Configure:

   • Resource path: /invoice/tags/
   • Resource name: {id}

4. Click Create resource.

5. After the resource is created, select /invoice/tags/{id}.
6. Click Create method.

7. Configure the Create method:

   • Method type: PATCH.
   • Integration type: Lambda function.
   • Lambda proxy integration: Enabled.
   • Lambda function: FetchInvoiceDetailsFunction.

8. Click Create method.

Step 3: Enable CORS for methods

1. In the resource tree of GetInvoiceAPI, select /invoice/{id}.
2. Click Enable CORS.

1. In Access-Control-Allow-Methods, Enabled CORS:

   • GET
   • PATCH

2. Click Save.

5. Repeat the above steps for the following resources:

   • /invoice/starred/{id}: Enabled CORS for PATCH
   • /invoice/tags/{id}: Enabled CORS for PATCH

Step 4: Deploy API

1. Click Deploy API.

2. In the Deploy API modal:

   • Stage: [New Stage].
   • Stage name: dev.
   • Deployment description: Test API Method GET.
   • Click Deploy.