Implementing ApiParamsImplicit

[chrishuttonch]

Hi there,

I'm trying to use the @ApiParamsImplicit annotation. Has this been implemented?

@RequestMapping(method = RequestMethod.GET)
@ResponseBody
@ApiParamsImplicit({@ApiParamImplicit(name="X-Header-1", dataType = "String", paramType = "header"), @ApiParamImplicit(name="X-Header-2", dataType = "String", paramType = "header")})
public RestApiResponse getUser(@RequestParam("userId") String userId) throws UserNotFoundException, UserDeletedException, InvalidUserException, InvalidUserFieldException, InvalidTokenException {
// code
    }

[dilipkrish]

@chrishuttonch Unfortunately thats not been implemented yet. Also the swagger-ui support for this was spotty when I looked at it a while ago. A quick google lead me to this ... which leads me to think that it might easier to configure on the UI than have the swagger ui infer it from the documentation.

[chrishuttonch]

I think there are two parts to this issue, the use of headers and adding extra params to the swagger ui to describe the api. Basically, I have a spring filter that grabs both "X-Header-1" and "X-Header-2" and adds a Request Parameter for the userId to the request before hitting the controller. I would like to describe the need for these two headers via something like the @ApiParamsImplicit.

[dilipkrish]

@chrishuttonch I think it would be especially useful if supported @RequestHeader annotation out of the box. As such supporting @ApiParamsImplicit is useful too, but in which case you are essentially have the knowledge of the fact that there are headers coming in, as in your case, in a filter. Its a useful feature regardless, we just need to think of how to implement it, especially in the light of the hypermedia support thats introduced in spring mvc

[durbon]

I have a problem with the definitions controller

 @Controller
 @RequestMapping ("/{country}/ad/{adId}/list")

I'd like to use @ApiParamsImplicits above my method because I use @Valid annotations with object AdModel

  @ApiParamsImplicit( @ApiParamImplicit(name ="country", value = "Country object that needs to be selected country api", required = true, dataType = "String", paramType = "body")) 
  public @ResponseBody Object listMultimediaByAdId(HttpServletRequest request, HttpServletResponse response, @ApiParam @Valid AdModel adModel)

The definition of adModel:

public class AdModel {


private String country;

private Integer adId;

 ...
 }

[dilipkrish]

@durbon May be I dont understand your question correctly. Are you trying to update your AdModel object based on your url path parameters?

Are you looking for something like this?

[durbon]

yes, I'd like to show on swagger documentation console into method form two parameters: country and adId.

These parameters updates my adModel based on these url path parameters, but I don't know how I can indicate by annotations for documentation.

thanks

[kldavis4]

so @dilipkrish is @RequestHeader not currently supported? If not, is there a feature request for it?

[dilipkrish]

@kldavis4 Thats on the todo list and this is the TODO item :)

[kldavis4]

@dilipkrish great, thanks, I will watch for it