fix(openapi): correctly merge plugin router prefix with route paths by Akash504-ai · Pull Request #25616 · strapi/strapi

Akash504-ai · 2026-03-03T16:02:15Z

What does it do?

Fixes an issue in the OpenAPI generator where plugin route prefixes were not merged with their route paths.

PluginRoutesProvider was returning router.routes directly and ignoring router.prefix, causing prefixed plugin routes (e.g. upload) to be generated under / instead of their actual base path.

This change merges router.prefix with route.path and normalizes the resulting path to prevent duplicate or trailing slashes.

Why is it needed?

When running: strapi openapi generate

Upload plugin routes were generated like:

"/": {
  "operationId": "upload/post"
}

Instead of:

"/upload": {
  "operationId": "upload/post"
}

This resulted in incorrect OpenAPI specifications for plugin routes.

How to test it?

Checkout develop
Run yarn build
Navigate to examples/kitchensink-ts
Run yarn develop
Run yarn strapi openapi generate
Open specification.json

Before fix:

"/": { "operationId": "upload/post" }

After fix:

"/upload": { "operationId": "upload/post/upload" }
"/upload/files"
"/upload/files/:id"

Related issue(s)/PR(s)

Fixes #25591

vercel · 2026-03-03T16:02:21Z

@Akash504-ai is attempting to deploy a commit to the Strapi Team on Vercel.

A member of the Team first needs to authorize it.

nclsndr · 2026-03-04T08:43:46Z

Thank your for raising this PR @Akash504-ai!
I'm making a pre-check on the feature design with the team. I'll then get back here for the code review.

jhoward1994 · 2026-03-09T10:02:17Z

-        : // Else, extract and flatten every route from each router
-          Object.values(routes).flatMap((router) => router.routes);
+        ? routes
+        : Object.values(routes).flatMap((router: any) => {


Could we use the type "router: Core.Router" here?

(import type { Core } from '@strapi/types';)

I'll update the type to router: Core.Router instead of any and push the change.

jhoward1994 · 2026-03-09T10:05:32Z

-          Object.values(routes).flatMap((router) => router.routes);
+        ? routes
+        : Object.values(routes).flatMap((router: any) => {
+            const prefix = router.prefix ?? '';


I think this might have to be something like this

const hasOwnPrefix = route.config != null && Object.prototype.hasOwnProperty.call(route.config, 'prefix'); const effectivePrefix = hasOwnPrefix ? (route.config.prefix ?? '') : (router.prefix ?? '');

Otherwise the changes would generate incorrect OpenAPI paths for e.g. packages/plugins/users-permissions/server/routes/content-api/auth.js as they have route level prefixes defined at config.prefix ?

I'll update the implementation to respect route-level prefixes before falling back to router.prefix and push the change shortly.

…in-prefix

Akash504-ai · 2026-03-09T10:42:35Z

Hi! @jhoward1994 I have pushed the requested changes.
The router type now uses Core.Router and the implementation respects route-level config.prefix before falling back to router.prefix. I also verified the build locally. Please let me know if any further adjustments are needed.

jhoward1994 · 2026-03-09T11:24:14Z

Thanks @Akash504-ai !

One more thing, would you be able to add this code to packages/core/openapi/__tests__/routes/plugins-route-provider.test.ts starting at L20

This will make sure we have unit tests that cover this new behaviour

    it('should prepend router prefix to route paths', () => {
      const strapiMock = {
        plugins: {
          upload: {
            routes: {
              'content-api': {
                type: 'content-api',
                prefix: '/upload',
                routes: [
                  {
                    method: 'GET',
                    path: '/',
                    handler: 'controller.find',
                    info: { type: 'content-api' },
                  },
                  {
                    method: 'GET',
                    path: '/files/:id',
                    handler: 'controller.findOne',
                    info: { type: 'content-api' },
                  },
                ],
              },
            },
          },
        },
      } as unknown as Core.Strapi;

      const provider = new PluginRoutesProvider(strapiMock);
      const { routes } = provider;

      expect(routes).toHaveLength(2);
      expect(routes[0].path).toBe('/upload');
      expect(routes[1].path).toBe('/upload/files/:id');
    });

    it('should use route config.prefix instead of router prefix when present', () => {
      const strapiMock = {
        plugins: {
          'users-permissions': {
            routes: {
              'content-api': {
                type: 'content-api',
                prefix: '/users-permissions',
                routes: [
                  {
                    method: 'POST',
                    path: '/auth/local',
                    handler: 'auth.callback',
                    info: { type: 'content-api' },
                    config: { prefix: '' },
                  },
                  {
                    method: 'GET',
                    path: '/users/me',
                    handler: 'user.me',
                    info: { type: 'content-api' },
                    config: { prefix: '' },
                  },
                ],
              },
            },
          },
        },
      } as unknown as Core.Strapi;

      const provider = new PluginRoutesProvider(strapiMock);
      const { routes } = provider;

      expect(routes).toHaveLength(2);
      // These routes have config.prefix = '', so they bypass the router prefix
      expect(routes[0].path).toBe('/auth/local');
      expect(routes[1].path).toBe('/users/me');
    });

    it('should handle mix of routes with and without config.prefix', () => {
      const strapiMock = {
        plugins: {
          'users-permissions': {
            routes: {
              'content-api': {
                type: 'content-api',
                prefix: '/users-permissions',
                routes: [
                  {
                    method: 'POST',
                    path: '/auth/local',
                    handler: 'auth.callback',
                    info: { type: 'content-api' },
                    config: { prefix: '' },
                  },
                  {
                    method: 'GET',
                    path: '/roles',
                    handler: 'role.find',
                    info: { type: 'content-api' },
                  },
                ],
              },
            },
          },
        },
      } as unknown as Core.Strapi;

      const provider = new PluginRoutesProvider(strapiMock);
      const { routes } = provider;

      expect(routes).toHaveLength(2);
      // config.prefix = '' bypasses router prefix
      expect(routes[0].path).toBe('/auth/local');
      // No config.prefix, uses router prefix
      expect(routes[1].path).toBe('/users-permissions/roles');
    });

    it('should handle routes with no router prefix', () => {
      const strapiMock = {
        plugins: {
          test: {
            routes: {
              'content-api': {
                type: 'content-api',
                routes: [
                  {
                    method: 'GET',
                    path: '/items',
                    handler: 'controller.find',
                    info: { type: 'content-api' },
                  },
                ],
              },
            },
          },
        },
      } as unknown as Core.Strapi;

      const provider = new PluginRoutesProvider(strapiMock);
      const { routes } = provider;

      expect(routes).toHaveLength(1);
      expect(routes[0].path).toBe('/items');
    });

Akash504-ai · 2026-03-09T11:50:43Z

@jhoward1994 I have added the unit tests for the plugin route prefix behavior and route-level prefix overrides. I also ran the tests locally to ensure everything passes. Please let me know if any adjustments are needed.

nclsndr · 2026-03-09T12:03:50Z

thank your for your help @Akash504-ai!

Akash504-ai · 2026-03-09T12:09:02Z

You're welcome @nclsndr! Happy to help

fix(openapi): correctly merge plugin router prefix with route paths

98fa9a4

github-actions Bot added the community Changes and fixes created by community members label Mar 3, 2026

dosubot Bot added pr: fix This PR is fixing a bug source: core:openapi Source is core/openapi package labels Mar 3, 2026

Akash504-ai mentioned this pull request Mar 3, 2026

openapi generator messes up upload paths. #25591

Closed

2 tasks

nclsndr self-assigned this Mar 4, 2026

nclsndr added this to the 5.38.1 milestone Mar 4, 2026

jhoward1994 reviewed Mar 9, 2026

View reviewed changes

jhoward1994 self-assigned this Mar 9, 2026

Akash504-ai added 2 commits March 9, 2026 15:48

Merge remote-tracking branch 'upstream/develop' into fix/openapi-plug…

e32e51c

…in-prefix

fix(openapi): respect route-level prefix and use Core.Router type

d24f9ea

test(openapi): add unit tests for plugin route prefix handling

72b67b1

Merge branch 'develop' into fix/openapi-plugin-prefix

f6d7e9e

jhoward1994 approved these changes Mar 9, 2026

View reviewed changes

jhoward1994 merged commit ff8912a into strapi:develop Mar 9, 2026
94 of 95 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(openapi): correctly merge plugin router prefix with route paths#25616

fix(openapi): correctly merge plugin router prefix with route paths#25616
jhoward1994 merged 5 commits intostrapi:developfrom
Akash504-ai:fix/openapi-plugin-prefix

Akash504-ai commented Mar 3, 2026 •

edited by nclsndr

Loading

Uh oh!

vercel Bot commented Mar 3, 2026

Uh oh!

nclsndr commented Mar 4, 2026

Uh oh!

jhoward1994 Mar 9, 2026 •

edited

Loading

Uh oh!

Akash504-ai Mar 9, 2026

Uh oh!

jhoward1994 Mar 9, 2026

Uh oh!

Akash504-ai Mar 9, 2026

Uh oh!

Akash504-ai commented Mar 9, 2026

Uh oh!

jhoward1994 commented Mar 9, 2026

Uh oh!

Akash504-ai commented Mar 9, 2026 •

edited

Loading

Uh oh!

nclsndr commented Mar 9, 2026

Uh oh!

Akash504-ai commented Mar 9, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

Akash504-ai commented Mar 3, 2026 • edited by nclsndr Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does it do?

Why is it needed?

How to test it?

Related issue(s)/PR(s)

Uh oh!

vercel Bot commented Mar 3, 2026

Uh oh!

nclsndr commented Mar 4, 2026

Uh oh!

jhoward1994 Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Akash504-ai Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

jhoward1994 Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

Akash504-ai Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

Akash504-ai commented Mar 9, 2026

Uh oh!

jhoward1994 commented Mar 9, 2026

Uh oh!

Akash504-ai commented Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nclsndr commented Mar 9, 2026

Uh oh!

Akash504-ai commented Mar 9, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Akash504-ai commented Mar 3, 2026 •

edited by nclsndr

Loading

jhoward1994 Mar 9, 2026 •

edited

Loading

Akash504-ai commented Mar 9, 2026 •

edited

Loading