Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

feat: Custom Server Routes for external backend api

Aperta
#885 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
nuxt, typescript
Ambito
api, developer-experience, devtools

Direzione di ricerca

Inizia esaminando l'entry point proposto /server/external/api.ts e il modo in cui sono configurate le route server Nuxt esistenti. Determina come si integrerebbero defineExternalApi, runtimeConfig.apiBase, i metodi delle route, gli header, le query e i cookie; il lavoro è concluso quando le API esterne possono essere assegnate e testate in DevTools senza una route server separata per ogni richiesta.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement
🆒 Your use case

Server routes are amazing for testing api routes quickly but in a lot of use cases we could be using an external backend and we want to be able to assign them and test them directly in the devtools.

🆕 The solution you'd like

A method in the /server directory to assign external api routes with the sole purpose to assign external apis, my suggestion is /server/external/api.ts where we can modify the external backend settings directly inside this file:


export default defineExternalApi((event) => {
  const runtimeConfig = useRuntimeConfig()
  event.baseUrl = runtimeConfig.apiBase

  return {
    '/login': {
      method: 'POST',
      headers: [...], // these are defaults that are modifiable
      queries: [...],
      cookies: [...]
    },
    '/logout': {
      method: 'GET',
      ...
    }
  }
})

for compatibility we could build a tool to convert directly from postman or .rest files etc.

🔍 Alternatives you've considered

Implementing a nuxt server route for every single request and routing everything through it but it's absolutely not efficient.

ℹ️ Additional info

I believe this will heavily improve the development experience across teams and if some documentation was able to be implemented directly into them too it would mean that any api service can build with whatever accepted format and plug the documentation directly into nuxt which would make it such a powerful tool for teams and individuals.

Lingua principale
TypeScript
Stelle
3.3k
Fork
214
Merge medio
19h 45m
PR unite (30g)
12

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di nuxt/devtools

Tutte le issue di nuxt/devtools

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.