how to use optional url parameters with NestjS

Question

I'm trying to replace our current backend service using Nestjs library, however, I want to create a route with 2 optional parameters in the URL something like :

/route/:param1/config/:OptionalParam3?/:OptionalParam3?

that means the route should catch :

route/aa/config
route/aa/config/bb
route/aa/config/bb/cc

how can I achieve that, I have tried to use ? and () but it's not working well.

score 21 · Accepted Answer · answered Jun 16 '20 at 12:12

21

Router params name should be unique. The correct route path is:

Existing one is:

/route/:param1/config/:OptionalParam3?/:OptionalParam3?

Correction:

/route/:param1/config/:OptionalParam3?/:OptionalParam4?

Opinion: You can use query params if the params are optional. It is never a good idea to create optional param routes (disagreements agreed). Both serve the same purpose, but having them as the query params makes it more understandable for debugging and fellow developers.

answered Jun 16 '20 at 12:12

Vinayak Sarawagi

914
7
11

`@Vinayak Sarawagi` your approach makes sense. But for the sake of url readability for service users sometimes it worth to keep longer url, but with a short option – Roman Apr 15 '21 at 18:10
not working for me.. not sure why getting the 404 Error.. my URL: resource1/:id1/resource2/:id2? – Cpp crusaders Jan 20 '22 at 04:41
1

figured another way as solution used something like this in NestJS @Delete([ 'resource1/:id1/resource2/:id2', 'resource1/:id1/resource2' ]) – Cpp crusaders Jan 20 '22 at 14:38
This approach is correct but doesn't consider the project is using NestJS, which offers a lot more readability – Alvin Jan 12 '23 at 03:06

score 19 · Answer 2 · answered Sep 07 '21 at 16:03

19

If you are looking for how to annotate an optional query parameter, you can do it like so:

@ApiQuery({
  name: "myParam",
  type: String,
  description: "A parameter. Optional",
  required: false
})
async myEndpoint(
  @Query("myParam") myParam?: string
): Promise<blah> { 
  [...] 
}

answered Sep 07 '21 at 16:03

AlejandroVD

1,576
19
22

This worked to me, but I could make it work with a custom path. – Alberto lopez jimenez Nov 17 '22 at 02:39
I tried this way but the api always returned 200 status without any content – huykon225 Jan 27 '23 at 02:11
1

The only way that worked for me in Swagger. – PokatilovArt Feb 13 '23 at 19:39
https://github.com/nestjs/swagger/issues/30#issuecomment-1250550921 – minlare May 22 '23 at 14:29

score 6 · Answer 3 · answered Apr 06 '22 at 12:35

I solved this problem by using @Query decorator as below:

Here is my controller:

@Get()
async getAll(@Query('someParameter') someParameter?: number) {
  return this.service.getAll(someParameter);
}

Here is my client (Angular) service:

getAll(someParameter?: number) {
  return this.http.get(`apiUrl/controllerAddress?someParameter=${someParameter}`
  );
}

score -1 · Answer 4 · answered Dec 02 '22 at 09:14

-1

You can use this structure:

-route -aa -config -[[...id]].js

It will work for the routes : route/aa/config/{anything}

answered Dec 02 '22 at 09:14

shubham agrawal

49
3

how to use optional url parameters with NestjS

4 Answers4