CODEWITHSUNDEEP
javaspring-mvcswaggerswagger-ui
Eugene
Eugene

Reputation: 121028

Swagger Spring mvc reponsebody

Is there a way to present the request body of a complex object in swagger with each field having it's input?

In simple words if one of my apis expects a Person (suppose it has just a firstname/lastname) as @RequestBody then the only way to provide this Person with swagger would be to give the entire json of Person. Is there a way to enable each separate field to have it's separate input for firstname/lastname for example?

Upvotes: 1

Views: 725

Answers (2)

Dilip Krishnan
Dilip Krishnan

Reputation: 5487

If you annotate your Operation using @ModelAttributeit should do exactly what you're looking for

For e.g. instead of 

public void updatePersonName(@RequestBody Person person) { ... }

Use this 

public void updatePersonName(@ModelAttribute Person person) { ... }

The @ModelAttribute will expand the primitive properties and provide fields for entering in the first name and last name in the swagger ui. The equivalent of that operation is 

public void updatePersonName(@RequestParam String firstName, 
                             @RequestParam String lastName) { ... }

Upvotes: 1

Virginia Woolf
Virginia Woolf

Reputation: 1268

I'm also using swagger with the default swagger UI and I don't think it's possible unless you change the swagger UI code. But a quite convenient solution is to define the type of your parameter and then provide the model for that type. For instance

 "parameters": [
                {
                    "in": "body",
                    "name": "body",
                    "description": "A Person",
                    "required": true,
                    "type": "Person"
                }
            ]

And then 

 "definitions": {
    "Person": {
      "properties": {
            "firstName": {
                "type": "string"
            },
            "lastName": {
                "type": "string"
            }
        }
      }
   }

This way the model appears in the UI and you can easily copy it to the request body textbox and fill it with content manually.

Upvotes: 0

Related Questions