RESTful API design for devices in IOT Protocols - Step-by-Step Execution

Process Flow - RESTful API design for devices

Client sends HTTP Request

↓

API Gateway receives request

↓

Route to Device Controller

↓

Process Request: GET/POST/PUT/DELETE

↓

Interact with Device or Database

↓

Prepare HTTP Response

↓

Send Response back to Client

This flow shows how a client request travels through a RESTful API to interact with devices, then returns a response.

Execution Sample

IOT Protocols

GET /devices/123
Host: api.example.com

Response: 200 OK
{
  "id": "123",
  "status": "online"
}

A client requests device 123 status; the API returns device info in JSON.

Process Table

Step	Action	Request/Response	Result
1	Client sends GET request for device 123	GET /devices/123	Request received by API gateway
2	API routes request to device controller	Routing	Controller ready to process
3	Controller queries device status	Query device 123	Device status found: online
4	Controller prepares JSON response	Response body	{"id": "123", "status": "online"}
5	API sends HTTP 200 OK with JSON	Response 200 OK	Client receives device info
6	End of request processing	N/A	Request complete

💡 Request completed after sending device info response

Status Tracker

Variable	Start	After Step 3	After Step 4	Final
request	None	GET /devices/123	GET /devices/123	Processed
device_id	None	123	123	123
device_status	None	online	online	online
response_body	None	None	{"id": "123", "status": "online"}	{"id": "123", "status": "online"}

Key Moments - 3 Insights

Why does the API use different HTTP methods like GET or POST?

Each HTTP method has a specific meaning: GET retrieves data, POST creates new data, PUT updates, DELETE removes. This is shown in the execution_table where GET fetches device info.

How does the API know which device to get info for?

The device ID is part of the URL path (e.g., /devices/123). The API extracts this from the request as shown in variable_tracker under device_id.

What format is used to send device data back to the client?

The API sends data in JSON format, a simple text format easy for clients to read, as shown in the response_body variable and execution_table step 4.

Visual Quiz - 3 Questions

Look at the execution_table at step 3, what is the device_status value?

A online

B offline

C unknown

D error

💡 Hint

Check the 'Result' column at step 3 in the execution_table

At which step does the API prepare the JSON response body?

A Step 2

B Step 3

C Step 4

D Step 5

💡 Hint

Look for 'prepares JSON response' in the Action column of execution_table

If the client used POST instead of GET, what would change in the execution flow?

A The API would retrieve device info

B The API would create a new device or data

C The API would delete the device

D The API would do nothing

💡 Hint

Recall the key_moments explanation about HTTP methods and their meanings

Concept Snapshot

RESTful API design uses HTTP methods (GET, POST, PUT, DELETE) to interact with devices.
Device IDs are passed in URL paths (e.g., /devices/123).
Responses are usually JSON formatted.
API routes requests to controllers that handle device data.
Clients send requests; API sends back status and data.
This design keeps communication simple and clear.

Full Transcript

In RESTful API design for devices, a client sends an HTTP request such as GET to retrieve device information. The API gateway receives this request and routes it to the appropriate device controller. The controller processes the request by querying the device or database for the requested data. It then prepares a JSON response containing device details like ID and status. Finally, the API sends this response back to the client with an HTTP status code, typically 200 OK for success. Variables like request, device_id, device_status, and response_body change as the request moves through these steps. Understanding HTTP methods is key: GET fetches data, POST creates new data, PUT updates, and DELETE removes. Device IDs in the URL tell the API which device to act on. JSON is the common format for responses, making it easy for clients to read. This flow ensures clear, organized communication between clients and devices through the API.

Practice

1. Which HTTP method is typically used to retrieve data from a device in a RESTful API?

easy

A. DELETE

B. GET

C. PUT

D. POST

Solution

1. Step 1: Understand HTTP methods in REST

   GET is used to request data without changing it, ideal for reading device info.

2. Step 2: Match method to action

   Since retrieving data means reading, GET fits best over POST, PUT, or DELETE.

3. Final Answer:

   GET -> Option B

4. Quick Check:

   Retrieve data = GET [OK]

Hint: GET always fetches data without changing it [OK]

Common Mistakes:

• Confusing POST with GET for data retrieval
• Using DELETE to get data
• Thinking PUT retrieves data

2. Which of the following is the correct RESTful URL to update the settings of a device with ID 123?

easy

A. /update/device/123

B. /device/123/update

C. /devices/settings/123

D. /devices/123/settings

Solution

1. Step 1: Identify RESTful URL structure

   RESTful URLs use nouns and hierarchy: resource then ID then sub-resource.

2. Step 2: Check options for correct pattern

   /devices/123/settings correctly shows device resource, ID, then settings sub-resource.

3. Final Answer:

   /devices/123/settings -> Option D

4. Quick Check:

   Resource/ID/sub-resource = /devices/123/settings [OK]

Hint: Use resource/ID/sub-resource format for REST URLs [OK]

Common Mistakes:

• Placing ID after sub-resource
• Using verbs like 'update' in URL
• Mixing singular and plural resource names

3. Given this RESTful API call: DELETE /devices/456, what is the expected result?

medium

A. Remove device 456 from the system

B. Update device 456 information

C. Retrieve device 456 details

D. Create a new device with ID 456

Solution

1. Step 1: Understand DELETE method purpose

   DELETE removes the specified resource from the server.

2. Step 2: Apply to device 456

   DELETE /devices/456 means remove device with ID 456 from the system.

3. Final Answer:

   Remove device 456 from the system -> Option A

4. Quick Check:

   DELETE method = remove resource [OK]

Hint: DELETE removes resources, not fetch or update [OK]

Common Mistakes:

• Thinking DELETE retrieves data
• Confusing DELETE with POST or PUT
• Assuming DELETE creates resources

4. You wrote this API call to update a device: POST /devices/789 but it creates a new device instead. What is the likely mistake?

medium

A. Using POST instead of PUT for update

B. Missing device ID in URL

C. Using GET method instead of POST

D. Incorrect device ID format

Solution

1. Step 1: Understand POST vs PUT

   POST usually creates new resources; PUT updates existing ones.

2. Step 2: Analyze the API call

   POST /devices/789 creates new device; to update, use PUT /devices/789.

3. Final Answer:

   Using POST instead of PUT for update -> Option A

4. Quick Check:

   Update needs PUT, not POST [OK]

Hint: Use PUT to update, POST to create [OK]

Common Mistakes:

• Using POST for updates
• Confusing GET with POST
• Ignoring HTTP method meaning

5. You want to design a RESTful API to control multiple devices' power state at once. Which design is best?

hard

A. PUT /device/{id}/power for each device separately

B. GET /devices/power to fetch all power states

C. POST /devices/power with JSON list of device IDs and states

D. DELETE /devices/power to reset all devices

Solution

1. Step 1: Identify batch update needs

   To control many devices at once, send a batch request with data.

2. Step 2: Match HTTP method and URL

   POST /devices/power with JSON list allows updating multiple devices in one call.

3. Step 3: Evaluate other options

   GET fetches data, PUT is per device, DELETE resets devices--none fit batch control well.

4. Final Answer:

   POST /devices/power with JSON list of device IDs and states -> Option C

5. Quick Check:

   Batch update = POST with data list [OK]

Hint: Use POST with data list for batch device updates [OK]

Common Mistakes:

• Using GET to change device states
• Trying PUT for batch updates
• Using DELETE to control power