UI does not show request body

[dthorpe]

Swagger-UI does not appear to show the request body in interactive "Try it out!" operations.

For example, see the wordnik api doc for authenticating the user using a POST request:
http://developer.wordnik.com/docs.html#!/account/authenticatePost_post_1

[fehguy]

swagger-ui is only designed to display the response body

[enricribas]

Do you want to eloborate? These seems like a silly response to me in my humble opinion. Why does SwaggerUI only show responses? Would it not be nice to see the exact request that is being sent, ideally as a JSON object?

[fehguy]

I think it depends on what swagger-ui is being used for. If interactive documentation, then the inputs for the request are the right scope of information. If as a debugging tool, then yes I can understand why you'd want to have the full raw request. If that's your goal, I'd suggest forking the UI and rendering the data--everything is available in the underlying swagger-js library.

[dthorpe]

Raw request vs "inputs for the request" is a pedantic distinction at this point - Swagger doesn't display request bodies in any form currently. All you can see is the output, not the input. As documentation for a web API, Swagger shows you only half of the information required to form a usable POST request.

[webron]

I don't follow your distinction between request bodies and request parameters.

[boeboe]

Oh sorry, I thought this was basic HTTP terminology.

>> GET /api/user?gender=male [request parameter]

@ApiOperation(value = "Get users")
@RequestMapping(value = "", method = RequestMethod.GET)
public List<User> getUsers(@RequestParam(value = "gender", required = false) String gender) { ... }


>> POST /api/user with HTTP request body content [request body]

    {
        name : "john doe"
        genader: "male"
    }

@ApiOperation(value = "Create a user")
@RequestMapping(value = "", method = RequestMethod.POST)
public User createUsers(@RequestBody @Valid User user) { ... }

[webron]

Since you opened #771, let's keep the correspondence there.