AWS

Last Authored: Monday, July 24th, 2023

REST API

This service allows you to deploy a public API endpoints that can hold GET, POST, PUT, PATCH or DELETE types of routes. TLDR

Currently only the GET option is supported in Project Compound and the routes you create can be accessed by anyone via the API url.

To declare a dynamic variable in the route, use {curly brackets}
/route/{dynamic-variable}

The extraction layer will automatically parse the route and allow you to configure actions for the variable.

If you choose to modify the routes of a deployed application, its always best to Redeploy API from the Dashboard page (Triggers and Testers > Ellipsis Button beside the API name > Redeploy API).

Behind the Scenes

To deploy REST API, we use AWS's API GATEWAY resource. This resource internally allows you to configure API endpoints and map them to an action. Through our guided user interface, we allow you to create GET endpoints and in the extraction stage map them to an action. We parse the route based on the data entered and if the route contains a dynamic route, we allow you to configure the action that should be associated to that dynamic route.

Follow the REST API to Dynamo DB tutorial to learn more