How to suppress requestBody generation in OpenAPI spec using swagger-maven-plugin

Question

I'm using the swagger-maven-plugin in a Java application with an old school servlet implementation. I'm trying to follow the examples here: https://github.com/swagger-api/swagger-samples/, but unfortunately this one: https://github.com/swagger-api/swagger-samples/blob/master/java/java-servlet/src/main/java/io/swagger/sample/servlet/SampleServlet.java which is the closest match, uses the 1.x version of swagger.core, not 2.x.

I found other examples that sort of work (see what I did below), except that it generates an almost 950 line requestBody element in the openapi.yaml doc for this endpoint. Why does it do that? Is there a way to suppress that? Below is the maven import and the code snippet:

<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-maven-plugin</artifactId>
<version>2.1.2</version>

The code with annotations is:

@Path("/Test00020")

public class Test00020 extends HttpServlet {

@Override

@GET

@Operation (

summary = "Ask something, get something back.",

parameters = { @Parameter(in = ParameterIn.QUERY, name="TestParam00020", required = true ) }

)

public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { ...

Thanks, Dave

frantuma · Accepted Answer

you can hide any parameter including request body via&nbsp;@Parameter.hidden annotation, like:
&nbsp;
    @Override
    @GET
    @Operation (
        summary = "Ask something, get something back.",
        parameters = { @Parameter(in = ParameterIn.QUERY, name="TestParam00020", required = true ) }
    )
    public void doGet(@Parameter(hidden = true) HttpServletRequest request, @Parameter(hidden = true) HttpServletResponse response) throws ServletException, IOException {
    }

frantuma · Answer

Hi Dave,
&nbsp;
"plain" servlets are not supported in 2.x version of swagger-core, as they are in 1.x version.
&nbsp;
You are probably getting a result anyway because you are using&nbsp;JAX-RS annotations (e.g. `@GET`), which "marks" the servlet method as processable by swagger-core.&nbsp;
&nbsp;
In your case I guess swagger-core is processing the request and response as parameters/request body which is clearly not what you want; you can add annotations (swagger-core 2.x ones) to specify parameters, request bodies and responses yourself defining exactly what you need&nbsp;(see swagger-core wiki and swagger-samples branch `2.0`).
&nbsp;

wichers · Answer

In the case of a normal GET request there is NO requestBody at all. I see how you can create a custom requestBody, per your comment: "you can add annotations (swagger-core 2.x ones) to specify parameters, request bodies and responses yourself defining exactly what you need&nbsp;(see swagger-core wiki and swagger-samples branch `2.0`)".&nbsp;But I see no way to completely suppress it. That's what I'm asking, how do you use swagger-core 2.0 annotations to completely supporess the requestBody. If there isn't any way to do that, maybe create a new feature request?

wichers · Answer

I'm trying to suppress the entire requireBody, not just the 'request' parameter. Using:@Parameter(hidden = true) HttpServletRequest request, doesn't work. As it generates this:&nbsp;&nbsp; &nbsp; &nbsp; requestBody:&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; content:&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; '*/*':&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; schema:&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: object&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; properties:&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; status:&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: integer&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; format: int32&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; headerNames:&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: array&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; items:&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: string&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; writer:&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: object&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; contentType:LOTS more ...&nbsp;&nbsp;The closest thing I can come up with is adding this to the @Operation block:&nbsp;&nbsp;requestBody = @RequestBody( required = false, content = @Content( ))&nbsp;But it still generates this:&nbsp;&nbsp; &nbsp; &nbsp; requestBody:&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; content:&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; '*/*': {}&nbsp;And I need it to omit the requestBody element entirely. What do you suggest at this point?

wichers · Answer

OK. That worked. It never occurred to me that I would have to 'hide' the response parameter in order to suppress generation of a requestBody, but after hiding that parameter too, the requestBody was not being generated anymore.&nbsp;Thanks for your help.

wichers · Answer

This solution suppresses requestBody generation, but only if you specify&nbsp;@Parameter(hidden = true)for both the request and response parameters.&nbsp;

Forum Discussion

How to suppress requestBody generation in OpenAPI spec using swagger-maven-plugin

11 Replies

Related Content

enums not generated in YAML file using swagger-maven-plugin

tags not generated in YAML file using swagger-maven-plugin

Generate multiple OAS 3.0 files using the swagger-maven-plugin

Problem with swagger generator (Maven codegen plugin)

Can't add requestBody to GET call in OpenAPI 3.0

Recent Discussions

Should the Curl command show the path to the file to be uploaded

ID_TOKEN as the header in the Google OAUTH2.0

How to hide an endpoint from openaopi 3.0

I can't see the "add item" button in swagger UI

Swagger Convertor Gateway Time-out