CODEWITHSUNDEEP
swagger
Kechit Goyal
Kechit Goyal

Reputation: 4262

APIs not getting detected by swagger on a Spring ROO project

I have tried a lot of things but APIs are not getting detected by swagger for some reason. Do i have to specify a package for swagger to scan? or some url include patterns?

My Swager Config : 

@Configuration
@EnableSwagger
@EnableWebMvc
public class SwaggerConfiguration {

private final Logger log = LoggerFactory
        .getLogger(SwaggerConfiguration.class);

/**
 * Swagger Spring MVC configuration.
 */
@Bean
public SwaggerSpringMvcPlugin swaggerSpringMvcPlugin(
        SpringSwaggerConfig springSwaggerConfig) {
    log.debug("Starting Swagger");
    StopWatch watch = new StopWatch();
    watch.start();
    SwaggerSpringMvcPlugin swaggerSpringMvcPlugin = new SwaggerSpringMvcPlugin(
            springSwaggerConfig).apiInfo(apiInfo())
            .genericModelSubstitutes(ResponseEntity.class);

    swaggerSpringMvcPlugin.build();
    watch.stop();
    log.debug("Started Swagger in {} ms", watch.getTotalTimeMillis());
    return swaggerSpringMvcPlugin;
}

/**
 * API Info as it appears on the swagger-ui page.
 */
private ApiInfo apiInfo() {
    return new ApiInfo("Title", "Description", "terms of service",
            "contact", "license", "licenseUrl");
}

}

Sample Controller 

@RequestMapping("/settings")
@Controller
@Api(value = "/settings", description = "Endpoint for settings management")
public class SettingsController {

@ApiOperation(value = "API Operation")
@RequestMapping(value = "/changepassword", method = RequestMethod.POST)
public @ResponseBody Map<String, Object> changePassword(@RequestParam Map<String, String> userProperties,
        Model model, HttpServletRequest httpServletRequest, Locale locale) {
    Map<String, Object> responseMap = new HashMap<String, Object>();
    return responseMap;
}

}

I get an empty response

{

"apiVersion": "1.0",
"swaggerVersion": "1.2",
"apis": [ ],
"authorizations": [ ],
"info": 

{
    "title": "Title",
    "description": "Description",
    "termsOfServiceUrl": "terms of service",
    "contact": "contact",
    "license": "license",
    "licenseUrl": "licenseUrl"
}

}

I am using swagger-springmvc version 1.0.2 and spring version 4.1.6.RELEASE

Upvotes: 1

Views: 349

Answers (1)

Kechit Goyal
Kechit Goyal

Reputation: 4262

Follow the instructions in the following URL :

http://naddame.blogspot.in/2014/12/spring-roo-mvc-integration-for-swagger.html

Upvotes: 1

Related Questions