Getting Started / Hands-on / ...

Module 4. Deploy a RESTful API

In this module, you use Amazon API Gateway to expose the Lambda functions that you built in the previous module as a RESTful API. The static website that you will host in the next module has a page configured to interact with the API that you create in this module.

Customize the FROM address used for email communications with your users

Build a serverless back end

Create a state machine

Deploy a RESTful API

Host a static website

Test your setup

Implementation instructions

Follow the step-by-step instructions below to create your REST API. Click on each step number to expand the section.

  • Step 1. Create a new RESTful API

    Amazon API Gateway enables you to create, publish, maintain, monitor, and secure your own REST and WebSocket API operations. Complete the following steps to create a new RESTful API.

    1. Open the Amazon API Gateway console at https://console.aws.amazon.com/apigateway.
    2. Do one of the following:
      • If this is your first API operation, the Get Started page displays. Choose Get Started.
      • In the Create Example API dialog box, choose OK.
      • If this is a subsequent API operation, choose Create API.
    3. Under Choose an API type, choose REST API and select Build.
    4. Under Choose the protocol, keep REST selected.
    5. Under Create new API, keep NEW API selected.
    6. Under Settings, do the following:
      • For API name, type examplecorp_eao.
      • For Description, you can optionally type a description.
      • For Endpoint Type, keep Regional selected.
    7. Choose Create API.

  • Step 2. Configure API Gateway for Lambda Integration

    To configure API Gateway for this workshop, complete the following steps.

    1. Open the Amazon API Gateway console at https://console.aws.amazon.com/apigateway .
    2. In the navigation pane, under the examplecorp_eao API, choose Resources.
    3. Choose Actions, Create Resource.
    4. Do the following:
      • For Resource Name, type execute.
      • For Resource Path, verify that the value is /execute.
      • Select the Enable API Gateway CORS check box.
      • Keep Configuer as proxy resource checkbox unchecked.
    5. Choose Create Resource.
    6. With your newly created resource (/execute) selected in the Resources pane, choose Actions, Create Method.
    7. Under OPTIONS, choose POST, and select the check mark to the right of the list.
    8. In the POST - Setup pane, do the following:
      • For Integration type, choose AWS Service.
      • For AWS Region, choose your Region.
      • For AWS Service, choose Step Functions.
      • Leave AWS Subdomain empty.
      • For HTTP method, choose POST.
      • For Action Type, leave Use action name selected.
      • For Action, type StartExecution.
      • For Execution Role, copy and paste the role ARN of the IAM service-linked role that you created earlier, examplecorp_eao_role.
      • For Content Handling, leave Passthrough selected.
      • For Use Default Timeout, leave the check box selected.
      • Choose Save.
    9.  With your newly created method (POST) selected in the Resources pane, choose Actions, Enable CORS.
    10. In the Enable CORS pane, keep the default values, and choose Enable CORS and replace existing CORS headers.
    11. In the Confirm method changes dialog box, choose Yes, replace existing values.
    12. A message displays to notify you that your resource has been configured for CORS.
    13. In the Resources pane, choose POST.
    14. Choose Actions, Deploy API.
    15. In the Deploy API dialog box, do the following:
      • For Deployment stage, choose [New Stage].
      • For Stage name, type test.
      • For Stage description and Deployment description, you can optionally type a description.
      • Choose Deploy.
    16. In the Stages pane, expand your newly created stage, test.
    17. Choose POST.
    18. At the top of the stage editor pane, the Invoke URL displays. Make a note of this URL. This URL is required later in the project.
Back to introduction
Next: Host a static website