Inspect URL object with `openapi-fetch`

[musjj]

Description

Sometimes it can be useful to inspect the constructed URL object from openapi-fetch. For example, when you want to create an <a> element that links to a GET route.

In Hono, you can inspect an API url like this:

let url = client.api.posts.$url()
console.log(url.pathname) // `/api/posts`

url = client.api.posts[':id'].$url({
  param: {
    id: '123',
  },
})
console.log(url.pathname) // `/api/posts/123`

Proposal

It would be nice if you can do this with openapi-fetch. Maybe the syntax can look like:

client.URL("/blogposts/{post_id}", {
  params: { post_id: "my-post" },
  query: { version: 2 },
});

Checklist

• I’m willing to open a PR for this (see CONTRIBUTING.md)

[drwpow]

Thanks for the suggestion but I think this is probably a bit too big of a change at this point for this syntax. You can always get the URL after-the-fact with response.url!

[sqs]

Here is a workaround that uses a dummy fetch impl to obtain the constructed URL without sending off the request:

            // HACK(sqs): We just want to get the URL that was previously fetched to invalidate.
            // There is no way in openapi-fetch to just get the URL directly, but this workaround
            // works. See https://github.com/openapi-ts/openapi-typescript/issues/1953.
            let urlToInvalidate: string | undefined = undefined
            await apiClient
                .request('get', '/foo/{id}', {
                    params: { path: { id: foo.id.toString() } },
                    fetch: req => {
                        urlToInvalidate = req.url
                        throw 'ignore'
                    },
                })
                .catch(() => {})
            await invalidate(urlToInvalidate!)