create api doc with swagger

Question

I tried generate some api via swagger without spring boot but it doesn't work

my swagger controller class

@Configuration
@EnableSwagger2
@Controller
@RequestMapping("/srs/api")
public class SwaggerConfig extends WebMvcConfigurerAdapter {
    @Bean
    @RequestMapping(value = "/v2/api-docs", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_VALUE)
    public Docket swaggerconf() {
        return new Docket(DocumentationType.SWAGGER_2)
                .useDefaultResponseMessages(false)
                .apiInfo(apiInfo("2.0"))
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo(String version) {
        return new ApiInfoBuilder()
                .title("API")
                .description("REST API")
                .version(version)
                .build();
    }
}

url is mapped

Mapped "{[/srs/api/v2/api-docs],methods=[GET],produces=[application/json]}" onto public springfox.documentation.spring.web.plugins.Docket com.my.applications.srs.rest.controllers.SwaggerConfig.swaggerconf()

But the documentation is not created did i miss something? may be I can use SpringBoot on server?

Do you depends too on the `springfox-swagger-ui` dependency? — Nicolas Labrot, Apr 05 '17 at 15:30
Do your logs contain `Mapped "{[/swagger-resources/configuration/ui]}"` ? — Nicolas Labrot, Apr 05 '17 at 15:34
>Do your logs contain Mapped "{[/swagger-resources/configuration/ui]}" ? – Nicolas Labrot 1 min ago don't contain — Ivan T, Apr 05 '17 at 15:37
So what does not work? `/srs/api/v2/api-docs` does not return json? — Nicolas Labrot, Apr 05 '17 at 15:39
`@Configuration` classes annotated with `@Controller` which extends `WebMvcConfigurerAdapter` with a `@RequestMapping` on a `Docket` seems a little weird to me. Have you look at [the swagger sample](https://github.com/springfox/springfox-demos/tree/master/boot-swagger) ? — Nicolas Labrot, Apr 05 '17 at 15:46
I runned swagger sample on tomcat like SpringBoot app and it's work — Ivan T, Apr 05 '17 at 15:51

score 1 · Accepted Answer · answered Apr 05 '17 at 15:59

Could you try to update your swagger configuration to:

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket swaggerconf() {
        return new Docket(DocumentationType.SWAGGER_2)
                .useDefaultResponseMessages(false)
                .apiInfo(apiInfo("2.0"))
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo(String version) {
        return new ApiInfoBuilder()
                .title("API")
                .description("REST API")
                .version(version)
                .build();
    }
}

Then import (if not already done) @Import this configuration into your Application like class.

When you bootstrap your application you should have a log like

 Mapped "{[/v2/api-docs],methods=[GET],produces=[application/json || application/hal+json]}" onto public org.springframework.http.ResponseEntity<springfox.documentation.spring.web.json.Json> springfox.documentation.swagger2.web.Swagger2Controller.getDocumentation(java.lang.String,javax.servlet.http.HttpServletRequest)

And if you open the url /v2/api-docs you should get a json

Thanks for the advice I runned with your config, but in logs i can't find Mapper /v2/api-docs :( — Ivan T, Apr 06 '17 at 09:23
Could you set a breakpoint on `return new Docket(DocumentationType.SWAGGER_2)` line and run your application in debug ? Does your debugger stop? — Nicolas Labrot, Apr 06 '17 at 09:45
Have you added `@Import(SwaggerConfig.class)` to your spring boot bootstrap class ? — Nicolas Labrot, Apr 06 '17 at 13:39

create api doc with swagger

1 Answers1