Vitest

Open in Playground Source

Test server routes with Vitest and serverFetch.

api

hello.ts

visits.ts

test

api.test.ts

nitro.config.ts

package.json

tsconfig.json

vite.config.ts

import { beforeEach, expect, test } from "vitest";
import { serverFetch } from "nitro";
import { useKV } from "nitro/kv";

beforeEach(async () => {
  await useKV().removeItem("visits");
});

test("GET /api/hello", async () => {
  const res = await serverFetch("/api/hello");
  expect(res.status).toBe(200);
  expect(await res.json()).toEqual({ message: "Hello from Nitro!" });
});

test("GET /api/visits", async () => {
  await serverFetch("/api/visits");
  const res = await serverFetch("/api/visits");
  expect(await res.json()).toEqual({ visits: 2 });
  expect(await useKV().getItem("visits")).toBe(2);
});

Test your server routes with Vitest. Vitest picks up the nitro() plugin from vite.config.ts, so test files run with the same routes, runtime config and storage as your server, without starting a dev server.

#Routes

import { defineHandler } from "nitro";
import { useRuntimeConfig } from "nitro/runtime-config";

export default defineHandler(() => {
  const { greeting } = useRuntimeConfig();
  return { message: `${greeting} from Nitro!` };
});

#Tests

test/api.test.ts

import { beforeEach, expect, test } from "vitest";
import { serverFetch } from "nitro";
import { useKV } from "nitro/kv";

beforeEach(async () => {
  await useKV().removeItem("visits");
});

test("GET /api/hello", async () => {
  const res = await serverFetch("/api/hello");
  expect(res.status).toBe(200);
  expect(await res.json()).toEqual({ message: "Hello from Nitro!" });
});

test("GET /api/visits", async () => {
  await serverFetch("/api/visits");
  const res = await serverFetch("/api/visits");
  expect(await res.json()).toEqual({ visits: 2 });
  expect(await useKV().getItem("visits")).toBe(2);
});

serverFetch sends a request through your Nitro app in-process. Runtime utilities like useKV work in tests too, so you can prepare or inspect state directly.

Run the tests with vitest, or vitest run for a single run.

#Learn More

Edit this page

Previous Vite + tRPC Next WebSocket

On this page