SvelteKit Endpoints Cheat Sheet

[lkj4]

This is a note to myself, the official docs provide all but I wanted a compact overview:

• A .ts in any folder creates a standalone endpoint
• A same named .svelte file ("page endpoint") in that folder turns the standalone endpoint into a shadow endpoint; now, the page endpoint automagically gets its props from latter without any fetch; this shadow endpoint can still be fetched independently from its page endpoint; be aware that the returned body type loses flexibility, now!
• fetch:
  • GET:
    1. the path and a { headers: { accept: 'application/json' } },
    2. or the path + /__data.json
    3. or you let the endpoint's filename end on .json.ts and then, fetch it with path + .json; be aware that here, the endpoint loses its shadow endpoint functionality but gets more flexibility over the returned body type!
  • POST: just the path and a respective POST signature (method, headers, etc.)

Even with the potential change of the routing discussed in #5037 non-page-endpoints shouldn't be affected (I presume).

My take regarding GET requests: a and b are recommended, c not because of the lacking shadow endpoint feature and the need to add a dedicated api folder structure for standalone endpoints which adds mental overhead when navigating the code base, I don't know a good use case why I would need more flexibility with the returned body type (to be discussed). To have more terse code, I'd default to option b.