Swagger UI not displying due to My SpringBoot Applcation each endpoint expects 2 query parameters

220 views Asked by At

My Spring boot application all endpoints expects 2 query parameters (http://localhost:myapplcation/getAll?pid=1101&token=jdu191092kj11) all endpoints are working as expected. But if I pass 2 query parameters I am able to see api swagger (http://localhost:8080/v2/api-docs?pid=1101&token=jdu191092kj11)

Problem with this Swagger UI .. nothing displaying http://localhost:8080/swagger-ui.html

how can I resolve this?

Below is the code:

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import static springfox.documentation.builders.PathSelectors.regex;

@Configuration
@EnableSwagger2
public class SwaggerConfig extends WebMvcConfigurationSupport {
    @Bean
    public Docket productApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.springframework.controllers"))
                .paths(regex("/product.*"))
                .build()
                .apiInfo(metaData());
    }
    private ApiInfo metaData() {
        return new ApiInfoBuilder()
                .title("Spring Boot REST API")
                .description("\"Spring Boot REST API for Online Store\"")
                .version("1.0.0")
                .license("Apache License Version 2.0")
                .licenseUrl("https://www.apache.org/licenses/LICENSE-2.0\"")
                .contact(new Contact("John Thompson", "https://springframework.com", "[email protected]"))
                .build();
    }
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

@RestController public class EmployeeController {

@Autowired
private EmployeeService employeeService;

@PostMapping("/admin/empproperties")
public @ResponseBody ResponseEntity<Employee> addNeeEmp(@RequestParam String fname, @RequestParam String sname) {
    Employee emp = new Employee();
    emp.setParam(fname);
    emp.setValue(sname);
    emp = employeeService.save(emp);
    return new ResponseEntity<Employee>(emp, new HttpHeaders(), HttpStatus.OK);
}


@GetMapping("/admin/empproperties")
public ResponseEntity<List<Employee>> allEmployees(){

    List<Employee> list = employeeService.findAll();
    return new ResponseEntity<List<Employee>>(list, new HttpHeaders(), HttpStatus.OK);

}

}

1

There are 1 answers

0
Deepak Jain On

In the regex you are adding product.* but in the url path you don't have product term.

Lets have it simple and see if that works like below

 @Bean
    public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(metaData())
         .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
        .paths(PathSelectors.any())
        .build();
    }