Add Swagger base path field in Nest.js project

Question

I am trying to use nestjs/swagger to create a swagger file from my back-end and I am facing a problem related to the base path. What I want to achieve is to show version as base path instead of showing it in all the methods available, which is ugly and confusing.

My API, right now, has the following structure (this is a set of what is present in app.module.ts):

const routes: Routes = [
  {
    path: '/api',
    module: ApiModule,
    children: [
      {
        path: '/v1',
        module: V1Module,
        children: [
          {
            path: '/orders',
            module: OrdersModule
          },
          {
            path: '/users',
            module: UsersModule
          }
        ]
      }
    ]
  }
];

This way, once I generate and check the swagger, I see all my methods following the /api/v1 prefix. This could be an example:

orders

GET   /api/v1/orders
POST  /api/v1/orders
GET   /api/v1/orders/{order_id}
...

users

GET   /api/v1/users
POST  /api/v1/users
GET   /api/v1/users/{user_id}
...

What I want is to get rid of /api/v1 appearing in any method. I know that SWAGGER has fields for host and basePath, but do not find any way to populate it in Nest.js. Researching, I have found that there were .setBasePath() and .addServer() methods, but they do not work for me (I am pretty sure they are deprecated).

Thank very much for your help.

Yeah but I do not want it to work that way. I want Nest.js to serve over /api/v1/ — msolefonte, Feb 20 '20 at 08:07

score 3 · Accepted Answer · answered Feb 20 '20 at 09:32

3

If you want nestjs to add api/v1 to every endpoint then use setGlobalPrefix('api/v1') to do that.

https://docs.nestjs.com/faq/global-prefix#global-prefix

answered Feb 20 '20 at 09:32

user8169516

46
2

5

I deleted my previous answers to update. This is really the way to go but I feel like it is poorly explained and confusing. What you have to do if you want to use `api/v1` as a global prefix is starting the app with `setGlobalPrefix('api/v1')`, delete the routes `api` and `v1` and set the children as main routes and add the configuration values `ingnoreGlobalPrefix` and `addServer('api/v1')`. I recommend you to update your answer to explain it. – msolefonte Feb 24 '20 at 12:20
You can use the versioning for the v1 part: https://docs.nestjs.com/techniques/versioning – Hugo Aug 30 '21 at 12:33

score 1 · Answer 2 · answered Apr 05 '23 at 21:50

1

This worked for me addServer(url)

answered Apr 05 '23 at 21:50

Raskolnikov

121
2
7

Add Swagger base path field in Nest.js project

2 Answers2