Vue Academy · Leçon

Routes serveur et points de terminaison d’API Nuxt

Répertoire server/api/, defineEventHandler(), utilitaires H3, intergiciel et gestion des erreurs

Leçon 3 sur 413 étapes

Routes serveur et points de terminaison d’API Nuxt est une leçon Vue Academy gratuite sur CoddyKit. Ceci est la leçon 3 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage Vue Academy, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours Vue Academy comprend 4 leçons au total.

Nuxt est une solution full-stack

Nuxt 3 inclut un moteur serveur (Nitro). Le répertoire server/ vous permet de créer des points d’accès API à côté de vos pages — aucun backend séparé n’est nécessaire pour de nombreuses applications.

Le répertoire server/api

Les fichiers de server/api/ deviennent des routes API sous /api. server/api/hello.ts répond à l’adresse /api/hello.

server/
  api/
    hello.ts   ->  /api/hello
    posts.ts   ->  /api/posts

defineEventHandler

Chaque route serveur exporte un gestionnaire créé avec defineEventHandler. Tout ce qu’il renvoie est envoyé dans la réponse et automatiquement sérialisé en JSON.

// server/api/hello.ts
export default defineEventHandler((event) => {
  return { message: 'Hello from the server' }
})

Suffixes des méthodes HTTP

Ajoutez un suffixe de méthode au nom du fichier pour le restreindre. users.get.ts gère GET et users.post.ts gère POST. Sans suffixe, la route répond à toutes les méthodes.

server/api/
  users.get.ts   ->  GET /api/users
  users.post.ts  ->  POST /api/users

Lire les paramètres de requête

Utilisez l’utilitaire getQuery pour lire la chaîne de requête de l’URL depuis l’événement.

export default defineEventHandler((event) => {
  const query = getQuery(event)
  return { search: query.q }
})

Lire le corps de la requête

Pour les requêtes POST/PUT, readBody analyse le corps JSON reçu. Cette opération est asynchrone : utilisez donc await.

export default defineEventHandler(async (event) => {
  const body = await readBody(event)
  return { received: body }
})

Routes serveur dynamiques

Les noms de fichiers entre crochets fonctionnent également côté serveur. server/api/users/[id].get.ts lit l’id avec getRouterParam.

export default defineEventHandler((event) => {
  const id = getRouterParam(event, 'id')
  return { id }
})

Générer des erreurs HTTP

Utilisez createError pour renvoyer des réponses d’erreur HTTP appropriées avec un code d’état et un message, plutôt que de lever une erreur ordinaire.

export default defineEventHandler((event) => {
  const id = getRouterParam(event, 'id')
  if (!id) {
    throw createError({ statusCode: 400, statusMessage: 'Missing id' })
  }
})

L’objet événement H3

L’argument event provient de H3, le framework HTTP de Nitro. Il contient la requête et la réponse et constitue le point d’entrée de toutes les fonctions utilitaires.

Définir l’état et les en-têtes

Des utilitaires comme setResponseStatus et setHeader vous permettent de contrôler la réponse lorsqu’il ne suffit pas de renvoyer une valeur.

export default defineEventHandler((event) => {
  setResponseStatus(event, 201)
  setHeader(event, 'Cache-Control', 'no-cache')
  return { created: true }
})

Appeler votre API depuis les pages

Depuis une page, récupérez votre propre point d’accès avec useFetch ou $fetch. Pendant le SSR, Nuxt appelle directement le gestionnaire, sans effectuer d’aller-retour HTTP.

const { data } = await useFetch('/api/posts')

Vérification rapide

Vérifiez vos connaissances sur les routes serveur de Nuxt.

Récapitulatif

Vous avez découvert les routes serveur de Nuxt :

  • Les fichiers de server/api/ deviennent des points d’accès API.
  • defineEventHandler définit un gestionnaire ; la valeur qu’il renvoie constitue la réponse.
  • Les suffixes de méthode .get.ts/.post.ts limitent la méthode HTTP.
  • Utilisez getQuery, readBody, getRouterParam et createError sur l’événement H3.
Gratuit pour commencer

Apprends HTML avec un tuteur IA — gratuit

Écris et exécute du vrai code dans ton navigateur, obtiens de l'aide instantanée d'un tuteur IA disponible 24h/24, et reprends là où tu t'es arrêté sur le web ou dans l'app.

Cours
42
Leçons
156

Questions Fréquemment Posées

La leçon « Routes serveur et points de terminaison d’API Nuxt » est-elle gratuite ?

Oui — le texte complet de « Routes serveur et points de terminaison d’API Nuxt » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours Vue Academy, passe à CoddyKit PRO. Le cours Vue Academy comprend 4 leçons au total.

Qu'est-ce que j'apprendrai dans « Routes serveur et points de terminaison d’API Nuxt » ?

Répertoire server/api/, defineEventHandler(), utilitaires H3, intergiciel et gestion des erreurs Tu pratiques Vue Academy avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.

Dois-je avoir de l'expérience pour commencer Vue Academy ?

Aucune expérience préalable n'est requise. Vue Academy sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 3 sur 4.

Combien de temps prend la leçon « Routes serveur et points de terminaison d’API Nuxt » ?

La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.

Peux-tu écrire et exécuter du code dans cette leçon Vue Academy ?

Oui. Chaque leçon Vue Academy inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.

Toutes les leçons de ce cours

  1. Structure d’un projet Nuxt 3 et routage fondé sur les fichiers
  2. Récupération des données : useFetch et useAsyncData
  3. Routes serveur et points de terminaison d’API Nuxt
  4. Modes SSR, SSG et SPA
← Retour à Vue Academy