Access route parameters within API function

[oscartbeaumont]

It would be really useful if when defining a route with parameters that you can access the parameter from within the API function.

For example for a route defined at /_api/api/thing/[...slug].ts, it would be great to be able to easily (and maybe even with typesafety) access the value of the slug or for /_api/thing/:a/:b to be able to acess the a and b values.

It's possible this exists already and I am just missing it but I couldn't find any examples in the repo or docs when I searched.

Currently i've been manually passing the URL from the request which works but is not great for long term maintaince. Eg. it will break if I move the file around because it hardcodes the path.

Thanks!

[dai-shi]

@tylersayshi What do you think?

[tylersayshi]

@oscartbeaumont this would be possible to support for static api routes that use staticPaths but not for others. Is that what you're hoping to get type safety for?

[oscartbeaumont]

I have updated the original issue as thinking about it more I think this issue is more generic than just wildcard parameters. It is just a way to access any URL parameters.

This would be possible to support for static api routes that use staticPaths but not for others

I'm curious why that would be? I feel that this would be a useful feature for any API route with parameters, whether it be dynamic or static.

From my limited understanding, given Waku is based on Hono I effectively am looking for a way to call c.param from API routes similar to the following code copied from their documentation:

app.get('/user/:name', async (c) => {
  const name = c.req.param('name')
  // ...
})

Although I am fine with it not being typesafe I think it would be smart to concider typesafety if this is implemented.

I think in practice one way we could expose this to the user is something like:

export function GET(req: Request, params: RouteParams<"/path/[...slug]">) { ... }`

Where the params argument is something like { slug: string } for the path /path/[...slug] and the RouteParams helper infers the path from the string by looking for the wildcard segment or route params in specific spots (Eg. /path/:a/:b would end up as { a: string; b: string }).

[oscartbeaumont]

If we can come up with a resonable API that both of you think fits in with Waku I would be happy to take a stab at implementing a solution!

[dai-shi]

From my limited understanding, given Waku is based on Hono

To be precise, Waku core is independent from Hono, so it's not possible.

We implemented route params for "pages" (but not for "layouts"), so it should be technically possible to implement that for api routes, unless I misunderstand. @tylersayshi

The reasonable API is to keep it the same as "pages" case.