Nitro server support

[skf-funzt]

Features

• [x] Nitro Server support :point_right: resolves #14
• [x] Automatic API route creation from OpenAPI schemas
• [x] Updated tests

Usage - Nitro Server support

nuxt.config.ts

export default defineNuxtConfig({
  ...
  openFetch: {
    clients: {
      pets: {
        baseURL: 'https://petstore3.swagger.io/api/v3'
      },
    },
    // Adding server support
    // ! The baseURL  needs to be set properly via config or the schema
    servers: {
      pets: {
        baseURL: 'https://petstore3.swagger.io/api/v3'
      },
    },
  },
  ...
})

server/api/pets.ts

export default defineEventHandler(async (event) => {
  const { $fetchPets } = useNuxtOpenFetchServer()
  return await $fetchPets ("/pet/{petId}", {
    path: {
      petId: 1,
    },
  });
})

Using automatic server API routes

const {
  data: usePetsFetchServerData,
  execute: usePetsFetchServerExecute,
  error: usePetsFetchServerError,
} = await usePetsFetchServer("/pet/{petId}", {
  immediate: false,
  path: {
    petId: 1,
  },
});

Improvements

• [x] Adding server routes from the schema automatically
• [x] A custom fetch interface to resolve local server routes the same way as the use[$client}Fetch approach

Missing

• [x] Add proper type support for server plugin - especially for the created functions
• [ ] Add documentation for server support
• [ ] Add usage example
• [ ] Working CI tests - currently only test:watch is working properly

[vercel[bot]]

Someone is attempting to deploy a commit to a Personal Account owned by @enkot on Vercel.

@enkot first needs to authorize it.

[skf-funzt]

@enkot I added the feature for automatic server API route creation. Could you please have a look?

[enkot]

Hi @skf-funzt Sorry for not replying for a long time. Thanks for your PR! I really appreciate it. 💚 While the general idea is correct, my vision for the implementation is a bit different. The idea is to have the same preconfigured client implementation in the Nuxt and Nitro context, same way we have plain $fetch:

// Nuxt
const { $petsFetch } = useNuxtApp()

$petsFetch('/pet/{petId}', {
  path: {
    petId: 2
  }
})

// Nitro
const { $petsFetch } = useNitroApp()

$petsFetch('/pet/{petId}', {
  path: {
    petId: 2
  }
})

Because it requires quite a lot of changes changes in this branch, I created another PR - https://github.com/enkot/nuxt-open-fetch/pull/23. I will add you as a contributor there :)

[skf-funzt]

@enkot What do you think about the automatic nitro route creation to avoid having CORS issues on the API's backend side?

[enkot]

I think handling CORS is beyond the scope of this module. NuxtOpenFetch simply extends $fetch/useFetch functionality with OpenAPI types.

[skf-funzt]

OK understood. Thanks for pointing that out. I thought it would be nice to have an immediate solution for the CORS issues with certain backends as I ran into the same issue and this was the solution for me without using a different package.

[enkot]

@skf-funzt I noticed you made some changes regarding /utils. Just want to note that utils was removed, and functions for module and runtime are used in place now. So it should work correctly now :)