Bdtjtk

While I was implementing Swagger , I found lot of help from the communities/blogs , but in one place . So I a summarizing the critical ones, just to save time for others..

1 . Need to include the dependencies..

        <!-- Added for Swagger Dependency -->

    <dependency>

        <groupId>io.springfox</groupId>

        <artifactId>springfox-swagger2</artifactId>

        <version>2.8.0</version>

        <scope>compile</scope>

    </dependency>

    <dependency>

        <groupId>io.springfox</groupId>

        <artifactId>springfox-swagger-ui</artifactId>

        <version>2.8.0</version>

        <scope>compile</scope>

    </dependency>

    <!--END Added for Swagger Dependency -->

2. 
   

   You need to have a Swagger config class ..

   
   
   

   @Configuration
   @EnableSwagger2
   public class SwaggerConfig extends WebMvcConfigurationSupport {

   
   
   

   @Bean
   
   public Docket productApi() {
   
   
   
   
   
       /*   Swagger : For Particular Rest Service under somepackge, someEndpoint
   
   
   
       return new Docket(DocumentationType.SWAGGER_2).select()
   
               .apis(RequestHandlerSelectors.basePackage("com.abcdli.somepackge.controller"))
   
               .paths(PathSelectors.regex("/someEndpoint.*")).build();*/
   
   
   
   
   
       /*  Swagger : Simple method for all the apis    
   
   
   
         return new Docket(DocumentationType.SWAGGER_2).select()
   
         .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build();
   
        */
   
   
   
        /*  
   
        Swagger : Simple method for all the apis under somepackage only         
   
        */
   
   
   
       return new Docket(DocumentationType.SWAGGER_2).select()
   
               .apis(RequestHandlerSelectors.basePackage("com.abcdli.yourpackage.controller"))
   
               .paths(PathSelectors.any())
   
               .build()
   
                /*  
   
                Swagger : metaInfo() is used for enrichment with details 
   
                   ApiInfo(title, description, version, termsOfServiceUrl, contactName, license, licenseUrl);
   
                */
   
               .apiInfo(metaInfo());
   
   
   
   
   
   
   
   }
   
   
   
   private ApiInfo metaInfo() {
   
   
   
       String description = ;
   
   
   
   
   
       return new ApiInfoBuilder()
   
               .title("YOUR APPLICATION NAME")
   
               .description(description)
   
               .version("1.0.0.1")
   
               .contact(new springfox.documentation.service.Contact("TEAM","www.mw.com","mw.abcd.com"))
   
               .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/");
   
   }
   
   

   
   
   

   }

   
   

3 . Now the Swagger Page is ready . Now need customize the controller , methods and models. This is very straight forward.

/*

Registering the RestAPI

*/

@Api(value="YourController",description="some description")

public class YourController {

    @RequestMapping(value = "/path", method = RequestMethod.POST, 

consumes = {

            "application/JSON" }, produces = { "application/JSON" })



/*

Registering the method

*/          

    @ApiOperation(value="Adding a method",response=Response.class)

    public ResponseEntity<Response> addMethodDetails(

            @RequestBody modifyReq) {



}

4. 
   

   You need provide access to these resources , if your API is secured with some authentication ..

   
   
   
   
   

   • //http.anonymous().disable(); [ anonymous ]

   
   

   • http.authorizeRequests()
     .antMatchers("/swagger-resources/",
     "swagger-resources/configuration/ui/*",
     "/swagger-ui.html",
     "/webjars/**",
     "favicon.ico").permitAll();