Response formatting in NextJS - Performance & Optimization

Performance: Response formatting

MEDIUM IMPACT

Response formatting affects how quickly the server sends data and how efficiently the browser processes it, impacting page load speed and interaction readiness.

Sending JSON data from a Next.js API route

NextJS

export default function handler(req, res) {
  const data = { message: 'Hello World', time: new Date().toISOString() };
  res.json(data);
}

Using res.json automatically sets headers and stringifies data efficiently; formatting date as ISO string reduces payload size.

📈 Performance GainSaves CPU cycles on manual stringify; smaller payload reduces network latency.

Sending JSON data from a Next.js API route

NextJS

export default function handler(req, res) {
  const data = { message: 'Hello World', time: new Date() };
  res.setHeader('Content-Type', 'application/json');
  res.send(JSON.stringify(data));
}

Manually stringifying JSON and setting headers can cause redundant processing and potential errors; also, sending unnecessary data increases payload size.

📉 Performance CostAdds extra CPU time for manual JSON.stringify; larger payload increases network transfer time.

Performance Comparison

Pattern	DOM Operations	Reflows	Paint Cost	Verdict
Manual JSON.stringify with extra data	N/A	0	Low but delayed by parsing	[X] Bad
res.json with minimal data	N/A	0	Low and fast parsing	[OK] Good

Rendering Pipeline

Response formatting affects the server-to-browser data transfer stage and the browser's parsing stage, influencing how quickly content becomes available for rendering.

→Network Transfer

→HTML/JSON Parsing

→Rendering

⚠️ BottleneckNetwork Transfer and Parsing

Core Web Vital Affected

LCP

Response formatting affects how quickly the server sends data and how efficiently the browser processes it, impacting page load speed and interaction readiness.

Optimization Tips

1Use res.json() to send JSON responses efficiently.

2Minimize data sent in responses to reduce payload size.

3Avoid manual JSON.stringify and header setting to save CPU time.

Performance Quiz - 3 Questions

Which response formatting method in Next.js improves performance by reducing CPU usage and payload size?

A Using res.json() with minimal data

B Manually stringifying JSON and setting headers

C Sending data as plain text without headers

D Sending large objects with unnecessary fields

DevTools: Network

How to check: Open DevTools, go to Network tab, reload the page or API call, select the response, and inspect the payload size and content.

What to look for: Look for smaller payload size and correct Content-Type header indicating efficient response formatting.

Practice

1. What is the main purpose of setting the Content-Type header in a Next.js API response?

easy

A. To set the status code of the response

B. To specify the HTTP method used in the request

C. To define the URL path of the API endpoint

D. To tell the client what type of data is being sent

Solution

1. Step 1: Understand the role of headers in HTTP responses

   Headers provide metadata about the response, including data format.

2. Step 2: Identify the purpose of Content-Type

   This header tells the client how to interpret the response body, e.g., JSON or HTML.

3. Final Answer:

   To tell the client what type of data is being sent -> Option D

4. Quick Check:

   Content-Type = Data format info [OK]

Hint: Content-Type always describes the data format sent [OK]

Common Mistakes:

• Confusing Content-Type with HTTP method
• Thinking Content-Type sets status code
• Mixing URL path with headers

2. Which of the following is the correct way to create a JSON response with status 200 in a Next.js API route?

easy

A. return new Response(data, { statusCode: 200, contentType: 'application/json' })

B. return Response(data, 200, { 'Content-Type': 'application/json' })

C. return new Response(JSON.stringify(data), { status: 200, headers: { 'Content-Type': 'application/json' } })

D. return new Response(JSON.stringify(data), 200, { 'Content-Type': 'text/plain' })

Solution

1. Step 1: Check the Response constructor syntax

   It takes the body as first argument, and an options object with status and headers.

2. Step 2: Verify correct headers and status usage

   Headers must include 'Content-Type' with 'application/json' for JSON data, and status should be 200.

3. Final Answer:

   return new Response(JSON.stringify(data), { status: 200, headers: { 'Content-Type': 'application/json' } }) -> Option C

4. Quick Check:

   Response(body, {status, headers}) = return new Response(JSON.stringify(data), { status: 200, headers: { 'Content-Type': 'application/json' } }) [OK]

Hint: Use new Response with JSON.stringify and proper headers [OK]

Common Mistakes:

• Passing data directly without JSON.stringify
• Using wrong header keys like contentType
• Incorrect argument order in Response

3. Consider this Next.js API handler code snippet:

export async function GET() {
  const data = { message: 'Hello' };
  return new Response(JSON.stringify(data), {
    status: 201,
    headers: { 'Content-Type': 'application/json' }
  });
}

What will be the HTTP status code and response body sent to the client?

medium

A. Status 201 with body '{"message":"Hello"}'

B. Status 200 with body '{"message":"Hello"}'

C. Status 201 with body 'Hello'

D. Status 200 with body 'Hello'

Solution

1. Step 1: Identify the status code set in the Response

   The code sets status to 201 explicitly in the Response options.

2. Step 2: Check the response body content

   The body is JSON.stringify(data), which converts { message: 'Hello' } to '{"message":"Hello"}'.

3. Final Answer:

   Status 201 with body '{"message":"Hello"}' -> Option A

4. Quick Check:

   Status and JSON body match Status 201 with body '{"message":"Hello"}' [OK]

Hint: Look for status in Response options and JSON.stringify body [OK]

Common Mistakes:

• Assuming default status 200 instead of 201
• Confusing raw string with JSON string
• Ignoring JSON.stringify usage

4. You wrote this Next.js API handler:

export async function POST() {
  const data = { success: true };
  return new Response(data, {
    status: 200,
    headers: { 'Content-Type': 'application/json' }
  });
}

What is the problem with this code?

medium

A. Headers object is missing required 'Accept' header

B. Response body must be a string or Blob, not an object

C. Status code 200 is invalid for POST requests

D. The function should not be async

Solution

1. Step 1: Check the Response body type

   The Response constructor expects a string, Blob, or similar, not a plain object.

2. Step 2: Identify the fix

   The object must be converted to a string using JSON.stringify before passing to Response.

3. Final Answer:

   Response body must be a string or Blob, not an object -> Option B

4. Quick Check:

   Response body type error = Response body must be a string or Blob, not an object [OK]

Hint: Always JSON.stringify objects before sending in Response body [OK]

Common Mistakes:

• Passing raw objects directly to Response
• Thinking status 200 is invalid for POST
• Adding unnecessary headers like Accept

5. You want to send a plain text response with status 404 from a Next.js API route. Which code snippet correctly formats this response?

hard

A. return new Response('Not Found', { status: 404, headers: { 'Content-Type': 'text/plain' } })

B. return new Response({ message: 'Not Found' }, { status: 404, headers: { 'Content-Type': 'application/json' } })

C. return new Response('Not Found', 404, { 'Content-Type': 'text/plain' })

D. return Response('Not Found', { status: 404, contentType: 'text/plain' })

Solution

1. Step 1: Confirm Response constructor usage

   It takes the body string first, then an options object with status and headers.

2. Step 2: Verify correct headers and status for plain text

   Status 404 is correct for 'Not Found', and Content-Type must be 'text/plain' for plain text.

3. Final Answer:

   return new Response('Not Found', { status: 404, headers: { 'Content-Type': 'text/plain' } }) -> Option A

4. Quick Check:

   Plain text + 404 status + correct headers = return new Response('Not Found', { status: 404, headers: { 'Content-Type': 'text/plain' } }) [OK]

Hint: Use string body with status and 'text/plain' header [OK]

Common Mistakes:

• Passing object instead of string for plain text
• Wrong argument order in Response
• Using contentType instead of headers key