Make use of nitro server API routes

fago commented 1 year ago

Idea: Introduce server API that proxies requests through the Drupal backend

/api/drupal/* ---> drupal/  (no cache by default)
/api/drupal-ce/   ---> drupal/ce-api/  (no cache by default)
/api/menu/{name} ---> drupal/api/rest_menu_items/{name}   (cached 5min by default, if possible disabled in dev)

Advantages:

Make use of route caching settings to cache API responses in Nuxt - https://nitro.unjs.io/guide/routing#route-rules
Possibility to simplify authentication by being able to simply set a cookie on the frontend domain + forward to the backend

Requirements:

Keep SSG working, hopefully nuxt handles that out-of-the-box
Be able to customize cache settings in projects by API endpoint

fago commented 1 year ago

Implementation plan:

Add new drupal-ce option "expose-api-route-rules" defaulting to TRUE
Have default route rules generated via module hook, support override config. If route-rule, pre-exists, the module does not alter it.
change default code to use the server-route instead of Drupal-API directly

Document "Customizing API route rules"

export default defineNuxtConfig({
  routeRules: {
    '/drupal-ce/**': { swr: true },
  }
})

StirStudios commented 1 year ago

Ah this is a great idea. I was going to ask about this.

fago commented 9 months ago

this is shipped in https://github.com/drunomics/nuxtjs-drupal-ce/releases/tag/v2.0.0-beta4

drunomics / nuxtjs-drupal-ce

Make use of nitro server API routes #165