Configuration option for different api routes not using /api prefix

[heisig]

Clear and concise description of the problem

It would be great to use other routes than /api/_sitemap-urls for handling dynamic URLs.
In our project, the routes with prefix /api are used differently and collide with the hardcoded server/api/_sitemap-urls.ts.

Suggested solution

If possible, a configuration could be implemented to choose the prefered route.
Here the nuxt documentation describes how to use server routes without the /api prefix

Maybe this route has to be configurable too: /api/__sitemap__/document-driven-urls

I would love to hear your thoughts on this topic.

Alternative

No response

Additional context

No response

[harlan-zw]

Hey @heisig, thanks for the suggestion!

Would you mind reviewing the PR to support it: #44

I'm hesitant to add supporting for modifying the /api/__sitemap__/document-driven-urls endpoint as it's one registered by the module. Is your site actually using it? If so, can you elaborate on the issues you have with this? Is it because you're applying some middleware to all api routes?

[heisig]

Thanks for the quick answer! I will have a look at the PR though I might not be the perfect person for a review.

Regarding the /api/__sitemap__/document-driven-urls endpoint: I am not sure what the purpose of this endpoint is. I just found it in the source code and thought it would be something to modify aswell when a dynamic endpoint is choosable.

For our site there is a reverse proxy which routes the client requests to the right destination. https://*frontend*/ to the nuxt server and among others https://*frontend*/api to a custom backend. Now every request going to /api will never get to the nuxt server. Custom endpoints for the sitemap would help our implementation in this regard.

[harlan-zw]

Thanks for the details :)

The PR is merged and available in 2.5.0. Give it a try and if you're still having issues happy to investigate further configuration requirements

export default defineNuxtConfig({
  sitemap: {
    dynamicUrlsApiEndpoint: '/__sitemap',
  },
})

[heisig]

Thanks a ton! All is working well and we can finally use the sitemap correctly :)