REST APIs - lesson 4 | HackIndia Skills

REST APIs - lesson 4 | HackIndia Skills | HackIndia

Example

Create request example

For a college event API, the client should send event details. The server should create the id and timestamps.

POST /v1/events
Content-Type: application/json

{
  "title": "AI Project Demo Day",
  "date": "2026-02-12",
  "venue": "Seminar Hall 2",
  "feeRupees": 0,
  "tags": ["ai", "college", "demo"]
}

Example

Response examples

A single resource response can be simple. A list response should use a stable wrapper.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "data": {
    "id": "evt_101",
    "title": "AI Project Demo Day",
    "date": "2026-02-12",
    "venue": "Seminar Hall 2",
    "feeRupees": 0,
    "tags": ["ai", "college", "demo"],
    "createdAt": "2026-01-20T10:30:00Z"
  }
}

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": [
    {
      "id": "evt_101",
      "title": "AI Project Demo Day",
      "date": "2026-02-12",
      "venue": "Seminar Hall 2",
      "feeRupees": 0,
      "tags": ["ai", "college", "demo"]
    }
  ]
}

Shape requests and responses

One stable shape

Requests are contracts

Shape request bodies

Create request example

Responses should be predictable

Response examples

Avoid shape drift

Use AI carefully

Do this now

Quick check