Forum Discussion

LeonardLai's avatar
LeonardLai
Occasional Contributor
6 years ago

Question about Swagger 2.X Annotations

Hi    I want to use Object(like sample below ：Contractor) to get input values from the frontend. May I use the @RequestBody annotation to define which parameters will pass(not all parameters ...
Swagger Core
frantuma's avatar
frantuma
Staff

assuming this in scope of usage of swagger-core to resolve an OpenAPI spec from a JAXRS project, you can indeed use @RequestBody (in the specific case you can even skip that, as the parameter Type will be resolved as requestBody); If you need to hide specific properties (if this is what you mean with "not all parameters in the Object") in Contractor, you can add @Hidden annotations there to the properties you want to hide.

LeonardLai's avatar
LeonardLai
Occasional Contributor
6 years ago

Thanks for your response.

I will show some pics to describe my question.

I want my swagger ui show like below

  • schema show all of my Course parameters

  • example value show part of my Course parameters

 

I use this code ,but not working.

 

@POST
	@Operation(summary = "insert new course")
	@Consumes(MediaType.APPLICATION_JSON)
	public Response insert(@RequestBody(required = true,
			content = @Content(schema = @Schema(implementation = Course.class,
                    example = "{'courseName': 'test','courseType': 'testtest','courseDescription': 'myDescription'}"))) Course course,
			
			@Context HttpServletRequest request,
			@Context HttpServletResponse response) {
		return null;
	}

 

Is it possible make schema and example value different with annotations?

 

 

Thanks