@http

Define HTTP routes in API Gateway with Lambda handler functions.

Syntax

Each route is made up of by two parts: verb & path

• HTTP Verb

  • get
  • post
  • put
  • patch
  • delete

• Path

  • Dashes and underscores are not allowed
  • Must begin with a letter
  • URL parameters are defined with a leading colon (:)

Additional bits

• Advised maximum of 100 characters

Example

These configuration examples show how to define @http routes:

@app
myapp

@http
get /
get /pages
get /pages/:dateID
get /contact
post /contact

{
  "app": "myapp",
  "http": [
    ["get", "/"].
    ["get", "/pages"],
    ["get", "/pages/:dateID"],
    ["get", "/contact"],
    ["post", "/contact"]
  ]
}

app="myapp"
http=[
  ["get", "/"],
  ["get", "/pages"],
  ["get", "/pages/:dateID"],
  ["get", "/contact"],
  ["post", "/contact"]
]

---
app: myapp
http:
- get: "/"
- get: "/pages"
- get: "/pages/:dateID"
- get: "/contact"
- post: "/contact"

Which generates the following scaffolding:

/
├── http
│   ├── get-index/
│   ├── get-pages/
│   ├── get-pages-000dateID/
│   ├── get-contact/
│   └── post-contact/
├── app.arc
└── package.json

⚠️ Handlers generated from routes with URL parameters i.e. /pages/:dateID, substitute : for 000.

This is a deliberate convention to ensure valid directory names that correspond with your defined parameterized route.