在 Nuxt 中自定义 useFetch

在使用 Nuxt 时，您可能正在构建前端并获取外部 API，并且您可能希望为从 API 获取数据设置一些默认选项。

该 $fetch 实用程序函数（由 useFetch 组合式使用）有意不进行全局配置。这很重要，以便在整个应用程序中保持一致的获取行为，并且其他集成（如模块）可以依赖于核心实用程序（如 $fetch）的行为。

但是，Nuxt 提供了一种为您的 API 创建自定义获取器的方法（如果您有多个 API 要调用，则可以创建多个获取器）。

自定义 `$fetch`

让我们使用 Nuxt 插件创建一个自定义 $fetch 实例。

$fetch 是 ofetch 的已配置实例，它支持添加 Nuxt 服务器的基本 URL 以及在 SSR 期间进行直接函数调用（避免 HTTP 往返）。

让我们假设这里

主要 API 是 https://api.nuxt.com
我们使用 nuxt-auth-utils 将 JWT 令牌存储在会话中。
如果 API 返回 401 状态代码，我们将用户重定向到 /login 页面。

plugins/api.ts

export default defineNuxtPlugin((nuxtApp) => {
  const { session } = useUserSession()

  const api = $fetch.create({
    baseURL: 'https://api.nuxt.com',
    onRequest({ request, options, error }) {
      if (session.value?.token) {
        // note that this relies on ofetch >= 1.4.0 - you may need to refresh your lockfile
        options.headers.set('Authorization', `Bearer ${session.value?.token}`)
      }
    },
    async onResponseError({ response }) {
      if (response.status === 401) {
        await nuxtApp.runWithContext(() => navigateTo('/login'))
      }
    }
  })

  // Expose to useNuxtApp().$api
  return {
    provide: {
      api
    }
  }
})

使用此 Nuxt 插件，$api 从 useNuxtApp() 中公开，以便直接从 Vue 组件进行 API 调用。

app.vue

<script setup>
const { $api } = useNuxtApp()
const { data: modules } = await useAsyncData('modules', () => $api('/modules'))
</script>

使用 useAsyncData 包装避免在执行服务器端渲染时进行双重数据获取（服务器和客户端在水合时）。

自定义 `useFetch`/`useAsyncData`

现在 $api 具有我们想要的逻辑，让我们创建一个 useAPI 组合式来替换 useAsyncData + $api 的用法。

composables/useAPI.ts

import type { UseFetchOptions } from 'nuxt/app'

export function useAPI<T>(
  url: string | (() => string),
  options?: UseFetchOptions<T>,
) {
  return useFetch(url, {
    ...options,
    $fetch: useNuxtApp().$api as typeof $fetch
  })
}

让我们使用新的组合式并获得一个简洁的组件。

app.vue

<script setup>
const { data: modules } = await useAPI('/modules')
</script>

如果您想自定义返回的任何错误的类型，您也可以这样做。

import type { FetchError } from 'ofetch'
import type { UseFetchOptions } from 'nuxt/app'

interface CustomError {
  message: string
  statusCode: number
}

export function useAPI<T>(
  url: string | (() => string),
  options?: UseFetchOptions<T>,
) {
  return useFetch<T, FetchError<CustomError>>(url, {
    ...options,
    $fetch: useNuxtApp().$api
  })
}

此示例演示了如何使用自定义 useFetch，但自定义 useAsyncData 的结构相同。

观看有关 Nuxt 中自定义 $fetch 和存储库模式的视频。

我们目前正在讨论如何找到更简洁的方法来让您创建自定义获取器，请参阅 https://github.com/nuxt/nuxt/issues/14736。

在 Nuxt 中使用 Vite 插件

了解如何将 Vite 插件集成到您的 Nuxt 项目中。

使用 <ClientOnly> 组件仅在客户端渲染组件。

自定义 $fetch

自定义 useFetch/useAsyncData

自定义 `$fetch`

自定义 `useFetch`/`useAsyncData`