Bird
Raised Fist0
Microservicessystem_design~10 mins

REST API between services in Microservices - Interactive Code Practice

Choose your learning style10 modes available

Start learning this pattern below

Jump into concepts and practice - no test required

or
Recommended
Test this pattern10 questions across easy, medium, and hard to know if this pattern is strong
Practice - 5 Tasks
Answer the questions below
1fill in blank
easy

Complete the code to define the HTTP method used to fetch data from another service.

Microservices
response = requests.[1]('http://service/api/data')
Drag options to blanks, or click blank then click option'
Aget
Bput
Cdelete
Dpost
Attempts:
3 left
💡 Hint
Common Mistakes
Using POST instead of GET to fetch data.
Confusing PUT with GET for data retrieval.
2fill in blank
medium

Complete the code to add a JSON payload when sending data to another service.

Microservices
response = requests.post('http://service/api/data', json=[1])
Drag options to blanks, or click blank then click option'
Adata
Bparams
Cheaders
Dpayload
Attempts:
3 left
💡 Hint
Common Mistakes
Passing headers or params instead of the actual data payload.
Using 'data' instead of 'payload' variable.
3fill in blank
hard

Fix the error in the code to correctly check if the response status code indicates success.

Microservices
if response.status_code == [1]:
    print('Success')
Drag options to blanks, or click blank then click option'
A404
B500
C200
D301
Attempts:
3 left
💡 Hint
Common Mistakes
Checking for 404 which means not found.
Using 500 which means server error.
4fill in blank
hard

Fill both blanks to correctly parse JSON data from the response and access the 'user' field.

Microservices
data = response.[1]()
user = data[2]'user')
Drag options to blanks, or click blank then click option'
Ajson
Btext
C['
D.get(
Attempts:
3 left
💡 Hint
Common Mistakes
Using response.text() instead of response.json().
Accessing dictionary keys with brackets without checking existence.
5fill in blank
hard

Fill all three blanks to build a REST API call with headers, query parameters, and handle the JSON response.

Microservices
headers = {'Authorization': 'Bearer [1]'}
params = {'id': [2]
response = requests.get('http://service/api/item', headers=headers, params=params)
data = response.[3]()
Drag options to blanks, or click blank then click option'
Atoken123
Bitem_id
Cjson
Dpayload
Attempts:
3 left
💡 Hint
Common Mistakes
Passing wrong variable names for headers or params.
Forgetting to parse JSON from response.

Practice

(1/5)
1. What is the main purpose of using a REST API between microservices?
easy
A. To allow services to communicate over HTTP using standard methods
B. To store data permanently in a database
C. To run services on the same machine only
D. To replace all backend logic with frontend code

Solution

  1. Step 1: Understand REST API role in microservices

    REST APIs enable communication between independent services using HTTP methods like GET, POST, PUT, DELETE.
  2. Step 2: Identify the correct purpose

    Storing data or running services on the same machine are not the main goals of REST APIs; they focus on communication.
  3. Final Answer:

    To allow services to communicate over HTTP using standard methods -> Option A
  4. Quick Check:

    REST API = communication over HTTP [OK]
Hint: REST APIs connect services via HTTP methods [OK]
Common Mistakes:
  • Confusing REST API with database storage
  • Thinking REST APIs run services locally only
  • Assuming REST replaces backend logic
2. Which HTTP method is typically used to update an existing resource in a REST API between microservices?
easy
A. GET
B. PUT
C. POST
D. DELETE

Solution

  1. Step 1: Recall HTTP methods and their purposes

    GET retrieves data, POST creates new data, PUT updates existing data, DELETE removes data.
  2. Step 2: Match method to update action

    Updating a resource is done with PUT, which replaces or modifies the resource at the given URL.
  3. Final Answer:

    PUT -> Option B
  4. Quick Check:

    Update = PUT [OK]
Hint: PUT method updates resources in REST APIs [OK]
Common Mistakes:
  • Using GET to update data
  • Confusing POST with update instead of create
  • Using DELETE to update resources
3. Consider this REST API call between two services:
GET /users/123

What is the expected result of this request?
medium
A. Retrieve details of the user with ID 123
B. Create a new user with ID 123
C. Delete the user with ID 123
D. Update the user with ID 123

Solution

  1. Step 1: Analyze the HTTP method and URL

    The method is GET, which is used to retrieve data. The URL targets user with ID 123.
  2. Step 2: Determine the action based on method

    GET requests fetch data without changing it, so it retrieves user details.
  3. Final Answer:

    Retrieve details of the user with ID 123 -> Option A
  4. Quick Check:

    GET /users/123 = retrieve user data [OK]
Hint: GET fetches data, not modifies it [OK]
Common Mistakes:
  • Thinking GET creates or deletes data
  • Confusing URL path with action
  • Assuming GET updates resources
4. A microservice sends a POST request to another service's REST API but receives a 405 Method Not Allowed error. What is the most likely cause?
medium
A. The request body is missing required fields
B. The URL endpoint does not exist
C. The HTTP method POST is not supported by the endpoint
D. The server is down

Solution

  1. Step 1: Understand 405 Method Not Allowed meaning

    This error means the server recognizes the URL but does not allow the HTTP method used.
  2. Step 2: Match error to cause

    If POST is not supported on that endpoint, the server rejects it with 405. Other issues cause different errors.
  3. Final Answer:

    The HTTP method POST is not supported by the endpoint -> Option C
  4. Quick Check:

    405 error = method not allowed [OK]
Hint: 405 means method not allowed on endpoint [OK]
Common Mistakes:
  • Confusing 405 with 404 (not found)
  • Assuming missing fields cause 405
  • Thinking server down causes 405
5. You design two microservices: Service A calls Service B's REST API to get user data. To improve scalability and reduce latency, which design choice is best?
hard
A. Service A calls Service B synchronously for every user request
B. Service A and B share a database to avoid API calls
C. Service B pushes user data to Service A via REST POST requests
D. Service A caches user data locally and refreshes periodically

Solution

  1. Step 1: Evaluate synchronous calls impact

    Calling Service B synchronously for every request adds latency and load, reducing scalability.
  2. Step 2: Consider caching benefits

    Caching user data locally in Service A reduces calls to Service B, improving response time and scalability.
  3. Step 3: Assess other options

    Service B pushing data is complex and not typical REST usage; sharing a database breaks microservice independence.
  4. Final Answer:

    Service A caches user data locally and refreshes periodically -> Option D
  5. Quick Check:

    Caching improves scalability and latency [OK]
Hint: Cache data locally to reduce cross-service calls [OK]
Common Mistakes:
  • Using synchronous calls for every request
  • Sharing databases between microservices
  • Expecting REST APIs to push data automatically