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
– Nicolas Labrot, Commented Apr 5, 2017 at 15:30
Do your logs contain Mapped "{[/swagger-resources/configuration/ui]}" ? — Nicolas Labrot
– Nicolas Labrot, Commented Apr 5, 2017 at 15:34
>Do your logs contain Mapped "{[/swagger-resources/configuration/ui]}" ? – Nicolas Labrot 1 min ago don't contain — Ivan T
– Ivan T, Commented Apr 5, 2017 at 15:37

Nicolas Labrot · Accepted Answer · 2017-04-05 15:59:25Z

1

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

answered Apr 5, 2017 at 15:59

Nicolas Labrot

4,16627 silver badges44 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Ivan T Over a year ago

Thanks for the advice I runned with your config, but in logs i can't find Mapper /v2/api-docs :(

Nicolas Labrot Over a year ago

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 Over a year ago

Have you added @Import(SwaggerConfig.class) to your spring boot bootstrap class ?

Collectives™ on Stack Overflow

create api doc with swagger

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related