Catch all segments dynamic api routes

[rinvii]

I'm not seeing any documentation related to catch all api routes. Is there support for this? Thank you so much for this amazing library :)

[Xunnamius]

Hi there! NTARH has support for all API route types. Testing catch-all routes shouldn't be too different from any other route, you just have to provide the expected params object.

Using the Next.js docs as an example (given URL /api/post/a/b/c):

/* file: pages/api/post/[...slug].ts */
import type { NextApiRequest, NextApiResponse } from 'next'
 
export default function handler(req: NextApiRequest, res: NextApiResponse) {
  const { slug } = req.query
  res.end(`Post: ${slug.join(', ')}`)
}

/* file: test/main.test.ts */
import { testApiHandler } from 'next-test-api-route-handler';
// Import the handler under test from the pages/api directory
import * as pagesHandler from '../pages/api/[...slug]';

it('does what I want', async () => {
  expect.hasAssertions();

  await testApiHandler({
    pagesHandler,
    params: { slug: ['a', 'b', 'c'] },
    test: async ({ fetch }) => {
      const res = await fetch({ method: 'POST' });
      await expect(res.text()).resolves.toBe('Post: a, b, c');
    }
  });
});