Provide an option to configure the API route path

[oliviertassinari]

Feature request

Is your feature request related to a problem? Please describe.

Next.js v9.0.0 hard codes the route name of the API path: /api/.

https://github.com/zeit/next.js/blob/71f9288a54c32420a18a07035ea7a73c9c3c50e5/packages/next/lib/constants.ts#L19

In Material-UI, we host pages under the /api/ folder. For instance: https://v3.material-ui.com/api/app-bar/. It forces us to rename this folder. This has an SEO impact.

Describe the solution you'd like

We would be interested in having an option to configure this path. For instance, I could imagine something like:

next.config.js

module.exports = {
  apiRoutePath: 'json-api',
};

Additional context

• The related thread on our side: [docs] Rename the /api/ folder mui/material-ui#16752
• I had an initial discussion about the problem with @timneutkens on Twitter.
• It seems relatively simple to implement as we have access to the config here:
  https://github.com/zeit/next.js/blob/71f9288a54c32420a18a07035ea7a73c9c3c50e5/packages/next/build/entries.ts#L51

[timneutkens]

It's actually not super simple to change it, and I'd rather not if not really required. We have talked about a page-level opt-out thought, but haven't really had community interest until now.

[eps1lon]

We have talked about a page-level opt-out

That would work for our use case. Will take a look at making this work. Any things I should pay extra attention to?

[timneutkens]

It's slightly complicated as this also ties into the serverless target and hosting (@now/next). I'll have @huv1k take a look 👍

[timneutkens]

Closing this in favor of #9081

[balazsorban44]

This issue has been automatically locked due to no recent activity. If you are running into a similar issue, please create a new issue with the steps to reproduce. Thank you.