swagger-core annotations required to specify HTTP requestBody form parameters?

Question

This is related to my other question today: https://community.smartbear.com/t5/Swagger-Open-Source-Tools/How-to-suppress-requestBody-generation-in-OpenAPI-spec-using/m-p/203314#M1192.&nbsp; I’m trying to now figure out how to use swagger-core annotations to specify requestBody form parameters.&nbsp; What I want to generate is described here: https://swagger.io/docs/specification/describing-request-body/ in the section “Form Data”. I specifically want to generate the .yaml described in the box under: “In OpenAPI 3.0, form data is modelled using a&nbsp;type: object&nbsp;schema where the object properties represent the form fields:”&nbsp;Here is my relevant swagger-core annotated code:&nbsp;&nbsp; @Path("/Test00020")&nbsp;&nbsp;public class Test00020 extends HttpServlet {&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @Override&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @POST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @Operation (&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; summary = "Ask something, get something back.",&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;requestBody = @RequestBody( description = "Form POST parameters in request body", required = true,&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; content = @Content( schema = @Schema(implementation = Object.class,&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; name = "Test00020" ))))&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @Consumes(MediaType.APPLICATION_FORM_URLENCODED)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; @Produces(MediaType.TEXT_HTML)&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { ...&nbsp;which results in this .yaml:&nbsp;paths:&nbsp;&nbsp;&nbsp; /Test00020:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; post:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; summary: Ask something, get something back.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; operationId: doPost&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; requestBody:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; description: Form POST parameters in request body&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; content:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; application/x-www-form-urlencoded:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; schema:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; type: object.&nbsp; &nbsp; &lt;-- Good up to here, but properties: block missing (see below)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; required: true&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; responses:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; default:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; description: default response&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; content:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; text/html: {}&nbsp;This is pretty close, but it is missing the parameter name and type param properties in the request body schema:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; properties:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Test00020:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; # &lt;!--- form field name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; type: string&nbsp;I couldn’t find any example of how to actually do this, and my trial and error got me this far. The name = "Test00020" element of the Content Schema is being ignored. Any clue how I fix my annotations to get it to work properly?

frantuma · Answer

As mentioned in my reply to your other question, swagger-core 2.x reader targets JAX-RS and its implementations: a typical APPLICATION_FORM_URLENCODED&nbsp;endpoint would be implemented e.g. in Jersey like&nbsp;this one&nbsp;processed as&nbsp;this test&nbsp;
&nbsp;
However your approach is almost right (using @RequestBody&nbsp;with @Content and @Schema) but adding schema properties via annotation is not (yet) supported. You have 2 options
&nbsp;
1. create a class representing your schema with properties, and use that in the `implementation` field, like:
&nbsp;
class Test00020RequestBody {

public String Test00020;

}
&nbsp;
@Path("/Test00020")

public class Test00020 extends HttpServlet {

@Override

@POST

@Operation (

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

requestBody = @RequestBody( description = "Form POST parameters in request body", required = true,

content = @Content( schema = @Schema(implementation =Test00020RequestBody.class))))

@Consumes(MediaType.APPLICATION_FORM_URLENCODED)

@Produces(MediaType.TEXT_HTML)

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

&nbsp;
or use a filter&nbsp;&nbsp;to programmatically define exactly what you need
&nbsp;

Forum Discussion

swagger-core annotations required to specify HTTP requestBody form parameters?

1 Reply

Related Content

Swagger UI in .Net Core 2.0 showing error

Can't add requestBody to GET call in OpenAPI 3.0

Support for XmlSchema JAXB annotation

Swagger Core annotation processing

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

Recent Discussions

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

Authorization Tag For Basic BASE64 Encoding