API Endpoints
Last updated
Last updated
API Endpoints contain method, path, and endpoint action configuration of a single API endpoint. API Endpoints make up Gateway Services but are kept distinct such that they can be reused in any number of Gateway services. Run Lambda actions that are performed at endpoints generally extend the class.The fields for defining endpoints are specified below.
Name*
The endpoint name
Description*
A description of the endpoint
Method*
The HTTP Method to use for this endpoint. One of GET, POST, PUT, or DELETE
Path*
A URL path starting with "/" that either directly specifies a route to match (i.e. /test), or uses a wildcard pattern that can match multiple routes (i.e. /:param or /*param). Under the hood, the API Gateway uses the for building the API. Consult the Router docs for more information regarding request path matching and parameters.
Action*
A preconfigured action of type "Run Lambda" to perform when this route is triggered.