Server routes and API in Vue - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a server route in a web application?

A server route is a path on the server that listens for requests from clients and sends back responses. It acts like a street address where the server knows what to do when someone visits that path.

beginner

How does an API relate to server routes?

An API (Application Programming Interface) uses server routes to let different programs talk to each other. Each route is like a door where the API accepts requests and sends back data or actions.

intermediate

In Vue, where do you typically define server routes for API calls?

In Vue apps, server routes are usually defined on the backend (like Node.js or another server). Vue calls these routes using HTTP requests (fetch or axios) to get or send data.

beginner

What HTTP methods are commonly used in server routes for APIs?

Common HTTP methods include GET (to get data), POST (to send new data), PUT/PATCH (to update data), and DELETE (to remove data). Each method tells the server what action to perform.

intermediate

Why is it important to handle errors in server routes?

Handling errors in server routes helps the app respond nicely when something goes wrong, like a missing page or bad data. It improves user experience and helps developers fix issues faster.

What does a server route do?

A Stores data on the client side

B Listens for client requests and sends responses

C Styles the webpage

D Runs Vue components

Server routes listen for requests from clients and send back responses.

Which HTTP method is used to get data from a server?

A PUT

B POST

C DELETE

D GET

GET requests are used to retrieve data from the server.

Where are server routes usually defined in a Vue app?

A In Vue components

B In CSS files

C In the backend server code

D In the browser console

Server routes are defined on the backend server, not inside Vue components.

What is the main purpose of an API?

A To allow programs to communicate

B To style web pages

C To store images

D To run Vue lifecycle hooks

APIs let different programs talk to each other by sending and receiving data.

Why should errors be handled in server routes?

A To improve user experience and debugging

B To hide data from users

C To slow down the server

D To make the app crash

Handling errors helps the app respond well and helps developers fix problems.

Explain how server routes and APIs work together in a Vue application.

Think about how Vue talks to the server to get or send data.

Describe the common HTTP methods used in server routes and their purposes.

Remember the four main actions you can do with data.

Practice

1. What is the main purpose of server routes in a Vue app using Nitro?

easy

A. To style the frontend components

B. To handle backend requests and send responses

C. To manage client-side state only

D. To create animations on the page

Solution

1. Step 1: Understand server routes role

   Server routes act as backend endpoints that receive requests from the frontend.

2. Step 2: Identify their function in Vue Nitro

   They process these requests and return data or responses, enabling communication between frontend and backend.

3. Final Answer:

   To handle backend requests and send responses -> Option B

4. Quick Check:

   Server routes = backend communication [OK]

Hint: Server routes handle backend requests, not frontend styling [OK]

Common Mistakes:

• Confusing server routes with frontend styling
• Thinking server routes manage only client state
• Assuming server routes create animations

2. Which of the following is the correct way to define a server route in a Vue Nitro project?

easy

A. app.get('/api', () => 'Hello')

B. const route = () => { console.log('Hello') }

C. export default defineEventHandler(() => { return { message: 'Hello' } })

D. function serverRoute() { return 'Hello' }

Solution

1. Step 1: Recognize Nitro server route syntax

   In Vue Nitro, server routes export a default function using defineEventHandler that returns data.

2. Step 2: Check each option

   export default defineEventHandler(() => { return { message: 'Hello' } }) uses defineEventHandler and returns an object, which is correct. Others either lack export, use wrong syntax, or are not Nitro style.

3. Final Answer:

   export default defineEventHandler(() => { return { message: 'Hello' } }) -> Option C

4. Quick Check:

   Use defineEventHandler for Nitro routes [OK]

Hint: Look for export default with defineEventHandler [OK]

Common Mistakes:

• Missing export default
• Not using defineEventHandler
• Using Express.js style instead of Nitro

3. Given this server route code in Vue Nitro:

export default defineEventHandler(() => { return { status: 'ok', count: 5 } })

What will the frontend receive when calling this API?

medium

A. Undefined

B. A string 'ok5'

C. An error because of missing await

D. { status: 'ok', count: 5 }

Solution

1. Step 1: Analyze the returned object

   The route returns an object with keys status and count, so the response is JSON with those values.

2. Step 2: Understand Nitro response behavior

   Nitro automatically serializes the returned object to JSON for the frontend.

3. Final Answer:

   { status: 'ok', count: 5 } -> Option D

4. Quick Check:

   Returned object = JSON response [OK]

Hint: Returned object becomes JSON response automatically [OK]

Common Mistakes:

• Expecting string concatenation
• Thinking await is needed for sync return
• Assuming undefined if no explicit JSON

4. What is wrong with this Vue Nitro server route code?

export default () => { return { message: 'Hi' } }

medium

A. Missing defineEventHandler wrapper

B. Return value must be a string

C. Export default is not allowed

D. Arrow function syntax is invalid

Solution

1. Step 1: Check Nitro route requirements

   Vue Nitro requires server routes to export a default function wrapped with defineEventHandler.

2. Step 2: Identify missing part

   The code exports a function but does not use defineEventHandler, so it won't work as a proper Nitro route.

3. Final Answer:

   Missing defineEventHandler wrapper -> Option A

4. Quick Check:

   Always wrap route with defineEventHandler [OK]

Hint: Always use defineEventHandler for server routes [OK]

Common Mistakes:

• Forgetting defineEventHandler
• Thinking return must be string
• Confusing export default rules

5. You want to create a server route in Vue Nitro that returns a list of users filtered by a query parameter `role`. Which code correctly accesses the query and returns filtered users?

hard

A. export default defineEventHandler(event => { const role = getQuery(event).role; return users.filter(u => u.role === role) })

B. export default defineEventHandler(() => { return users })

C. export default defineEventHandler(event => { const role = event.node.req.url.split('role=')[1]; return users.filter(u => u.role === role) })

D. export default defineEventHandler(event => { const role = event.query.role; return users.filter(u => u.role === role) })

Solution

1. Step 1: Understand query access in Nitro

   Vue Nitro provides a helper getQuery(event) to safely get query parameters from the request.

2. Step 2: Check each option for correct query usage

   export default defineEventHandler(event => { const role = getQuery(event).role; return users.filter(u => u.role === role) }) uses getQuery(event).role correctly. export default defineEventHandler(event => { const role = event.node.req.url.split('role=')[1]; return users.filter(u => u.role === role) }) manually parses URL which is error-prone. export default defineEventHandler(() => { return users }) ignores query. export default defineEventHandler(event => { const role = event.query.role; return users.filter(u => u.role === role) }) uses event.query which is not standard.

3. Final Answer:

   export default defineEventHandler(event => { const role = getQuery(event).role; return users.filter(u => u.role === role) }) -> Option A

4. Quick Check:

   Use getQuery(event) to read query params [OK]

Hint: Use getQuery(event) to access query parameters [OK]

Common Mistakes:

• Parsing URL manually instead of getQuery
• Using event.query which is undefined
• Ignoring query parameters