API Gateway Configuration

In this section, we will configure Amazon API Gateway to act as the primary endpoint for all deployed Lambda functions. Additionally, we will secure the API by integrating a Cognito Authorizer.

Step 1: Configure API Gateway Resources

1. Search for API Gateway in the AWS Console.

   

2. Select the API Gateway that was previously created (or create a new HTTP/REST API).

   

3. Select the document resource.

   

4. Click Create resource.

   

5. Enter {documentId} as the resource name.

   

6. Click Create resource.

   

7. Repeat the process to create the following resource paths:

   • /documents/{documentId}/process

     

   • /documents/{documentId}/review

     

8. Verify the completed resource structure.

   

Step 2: Create Methods and Integrate Lambdas

1. Select the document resource and click Create method.

   

2. Select GET as the method type.

   

3. Enable Lambda proxy integration.

   

4. Choose the lambda function ending with docuflow-dev-data-list-documents-lambda.

   

5. Click Create method.

   

6. Repeat the process to create the following methods and map them to their respective Lambda functions. Routes marked optional extension depend on the three extended Lambdas from section 5.7.2 and are not required for the approved MVP:

   • Optional extension: DELETE /documents ➔ docuflow-dev-data-delete-lambda

   • Optional extension: DELETE /documents/{documentId} ➔ docuflow-dev-data-delete-lambda

   • GET /documents/{documentId} ➔ docuflow-dev-data-get-document-lambda

   • Optional extension: POST /documents/{documentId}/process ➔ docuflow-dev-data-process-control-lambda

   • PATCH /documents/{documentId}/review ➔ docuflow-dev-data-review-update-lambda

   • Optional extension: POST /documents/{documentId}/retry ➔ docuflow-dev-data-process-control-lambda

   • POST /documents/upload-url ➔ docuflow-dev-api-generate-upload-url-lambda

   • Optional extension: GET /notifications ➔ docuflow-dev-data-dashboard-lambda

   • Optional extension: PATCH /notifications/{notificationId} ➔ docuflow-dev-data-dashboard-lambda

   • Optional extension: GET /activity ➔ docuflow-dev-data-dashboard-lambda

   • Optional extension: GET /reports/summary ➔ docuflow-dev-data-dashboard-lambda

Step 3: Configure Cognito Authorizer

1. In the API Gateway console, select Authorizers from the left navigation pane.

   

2. Click Create authorizer.

   

3. Enter docuflow-dev-cognito-authorizer as the name.

   

4. Set the Authorizer type to Cognito.

   

5. Select the Cognito User Pool created earlier.

   

6. Enter Authorization into the Token source field.

   

7. Click Create authorizer.

   

Step 4: Secure Methods using the Authorizer

1. Navigate to the DELETE method of /documents and click Edit in the Method request settings.

   

2. Under Authorization, select the Cognito Authorizer created previously and click Save.

   

3. Repeat this process for all other methods:

   • GET /documents
   • DELETE /documents (optional extension)
   • GET /documents/{documentId}
   • DELETE /documents/{documentId} (optional extension)
   • POST /documents/{documentId}/process (optional extension)
   • POST /documents/{documentId}/retry (optional extension)
   • PATCH /documents/{documentId}/review
   • POST /documents/upload-url
   • GET /notifications (optional extension)
   • PATCH /notifications/{notificationId} (optional extension)
   • GET /activity (optional extension)
   • GET /reports/summary (optional extension)

Step 5: Deploy API and Update Frontend

1. On the main API page, click Deploy API.

   

2. Select New stage, enter dev for the Stage name, and click Deploy.

   

3. Once deployed, the Stage details page will appear. Copy the Invoke URL.

   

4. Paste the Invoke URL into the VITE_API_GATEWAY_URL (or VITE_API_BASE_URL) variable in your frontend’s .env file.