SpringFox Swagger - Optional and Mandatory fields in model

java spring spring-boot swagger springfox
Punter Vicky picture Punter Vicky · May 4, 2017 · Viewed 14.9k times · Source

I used SpringFox library for rest documentation of my spring boot app. When I click on model , all the elements are being returned as optional. Is there a way to display required elements as mandatory? Is there any additional configuration that needs to be added?

Answer

Ganesh picture Ganesh · May 4, 2017

Yes by default All the fields will be optional. To mark a field as required you can use following annotation.

@ApiModelProperty(required = true)

On the getter method of the field which should be required. This won't show the field as "mandatory". But the optional tag will be removed for this field in the documentation.

Hope this helps.

Related questions

Add Swagger Basic AUTH to Spring Boot App

Requirements: Spring Boot application with Springfox Add BASIC authentication to Swagger Pass on all other requests Code: implemented @EnableWebSecurity @Configuration public class SecurityConfig extends WebSecurityConfigurerAdapter { @Override protected void configure(HttpSecurity http) throws Exception { http .authorizeRequests() .antMatchers("/swagger-resources/*", "*.html", "/api/v1/…

Read More
How do you turn off swagger-ui in production

I have swagger plugged in to my spring boot application. Spring boot allows you to have property files for each environment that you have. Is there a way to disable swagger for a production environment?

Read More
How to fully disable swagger-ui in spring-boot?(/swagger-ui.html should return 404)

I have read following topic: Disabling Swagger with Spring MVC and I wrote: @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("com.project.name.controller")) .paths(PathSelectors.ant("/api/**")) .build() .apiInfo(apiInfo()) .enable(false); } But …

Read More