Using Java objects as request parameters breaks down to primitives in swagger ui springfox

Question

I have the following controller code

@GetMapping("/users")
public ResponseEntity<UserDto> getUsers(Filter filter) {
    return ResponseEntity.ok(userService.findUsers(filter));
}

Filter.java:

public class Filter {
    private Integer page;

    private Integer size;

    // Contains 2 fields: "propertyName" and "order"
    private Sort sort;

    ... getters and setters
}

The URL is following: /users?page=1&size=10&sort=+firstName. So I have a custom converter from String to Sort and it works perfectly.

However, the generated swagger documentation is incorrect:

"parameters":[  
           {  
              "name":"sort.propertyName",
              "in":"query",
              "required":false,
              "type":"string"
           },
           {  
              "name":"sort.order",
              "in":"query",
              "required":false,
              "type":"string",
              "enum":[  
                 "+",
                 "-"
              ]
           },
           {  
              "name":"page",
              "in":"query",
              "required":false,
              "type":"integer",
              "format":"int32"
           },
           {  
              "name":"size",
              "in":"query",
              "required":false,
              "type":"integer",
              "format":"int32"
           }
]

As you can see, it has broken down the Sort field of Filter and has generated 2 parameters: sort.propertyName and sort.order. Instead, I want to have one parameter sort with type string.

Is there any way to achieve that? I have tried annotating the sort field with @ApiParam(name = "sort", value = "Sort", type = "string"), but it doesn't work.

You can create an alternate type rule to treat Sort as a String — Dilip Krishnan
– Dilip Krishnan, Commented Apr 22, 2018 at 11:23
Thanks, @DilipKrishnan, that worked! Can you please add your comment as an answer, so that I can accept it? — Archie
– Archie, Commented Apr 25, 2018 at 9:38

Dilip Krishnan · Accepted Answer · 2018-04-26 11:44:00Z

1

You could create an alternate type rule that treats Sort as a String

import static springfox.documentation.schema.AlternateTypeRules.*;
...
// Configure your docket bean
    new Docket(...)
         ...
         .alternateTypeRules(newRule(Sort.class, String.class)
         ...

answered Apr 26, 2018 at 11:44

Dilip Krishnan

5,4973 gold badges40 silver badges53 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Using Java objects as request parameters breaks down to primitives in swagger ui springfox

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related