springfox / springfox

Automated JSON API documentation for API's built with Spring
http://springfox.io
Apache License 2.0
5.93k stars 1.54k forks source link

ExternalDocs document level #1989

Open vpetit35 opened 7 years ago

vpetit35 commented 7 years ago

Versions (springfox-swagger2 - 2.6.1) (springfox-swagger-ui - 2.5.0)

Not sure if bug or misunderstood.

I am using Springboot and I seem not able to fill informations into the externalDocs object (like this line 18). When the doc is generated (http://appname/v2/api-docs), there is nothing about it.

Here is the way I configured it

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {

   @Bean
   public Docket customImplementation() {
        return new Docket(DocumentationType.SWAGGER_2).select()
             .apis(RequestHandlerSelectors.basePackage("package")).build()
             .useDefaultResponseMessages(false)
             .apiInfo(new ApiInfo(...));
    }
   @Bean
   ExternalDocs externalDocs() {
        return new ExternalDocs("Getting started", "http://mydoc.html");
   }

   @Bean
   SecurityConfiguration security() {
        return new SecurityConfiguration(...);
    }

    ...

}
dilipkrish commented 7 years ago

This feature has not been implemented. Would really appreciate a contribution for this.