Rest Api Spring 4 - Swagger - API Documentation

Swagger Configuration For your Project.

1) Pom.xml for Jars 

<!-- SWAGGER DEPENDANCY START -->

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger2</artifactId>

<version>2.7.0</version>

<scope>provided</scope>

</dependency>

<dependency>

<groupId>io.springfox</groupId>

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

<version>2.7.0</version>

<scope>provided</scope>

</dependency>

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-core</artifactId>

<version>2.7.0</version>

<scope>provided</scope>

</dependency>

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-spi</artifactId>

<version>2.7.0</version>

<scope>provided</scope>

</dependency>

<dependency>

<groupId>io.swagger</groupId>

<artifactId>swagger-annotations</artifactId>

<version>1.5.10</version>

<scope>provided</scope>

</dependency>

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-spring-web</artifactId>

<version>2.7.0</version>

<scope>provided</scope>

</dependency>

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger-common</artifactId>

<version>2.7.0</version>

<scope>provided</scope>

</dependency>

<dependency>

<groupId>com.google.guava</groupId>

<artifactId>guava</artifactId>

<version>18.0</version>

<scope>provided</scope>

</dependency>

<dependency>

<groupId>org.springframework.plugin</groupId>

<artifactId>spring-plugin-core</artifactId>

<version>1.2.0.RELEASE</version>

<scope>provided</scope>

</dependency>

<dependency>

<groupId>org.springframework.plugin</groupId>

<artifactId>spring-plugin-metadata</artifactId>

<version>1.2.0.RELEASE</version>

<scope>provided</scope>

</dependency>

<dependency>

<groupId>io.swagger</groupId>

<artifactId>swagger-models</artifactId>

<version>1.5.13</version>

<scope>provided</scope>

</dependency>

<dependency>

<groupId>org.slf4j</groupId>

<artifactId>slf4j-api</artifactId>

<version>1.7.12</version>

<scope>provided</scope>

</dependency>

<dependency>

<groupId>org.jboss.logging</groupId>

<artifactId>jboss-logging</artifactId>

<version>3.3.0.Final</version>

<scope>provided</scope>

</dependency>

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-schema</artifactId>

<version>2.7.0</version>

<scope>provided</scope>

</dependency>

<!-- SWAGGER DEPENDANCY END -->

2) Swagger Config Class

package com.dreamz.configuration;

import com.google.common.base.Predicate;

import com.google.common.base.Predicates;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;

import springfox.documentation.builders.PathSelectors;

import springfox.documentation.builders.RequestHandlerSelectors;

import springfox.documentation.service.ApiInfo;

import springfox.documentation.spi.DocumentationType;

import springfox.documentation.spring.web.plugins.Docket;

import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration

@EnableSwagger2

public class SwaggerConfig {

    @Bean

    public Docket api() {

        return new Docket(DocumentationType.SWAGGER_2).useDefaultResponseMessages(false)

                .apiInfo(apiInfo())

                .select()

                .apis(RequestHandlerSelectors.any())

                .paths(paths())

                .build();

    }

    // Describe your apis

    private ApiInfo apiInfo() {

        return new ApiInfoBuilder()

                .title("Swagger Sample APIs")

                .description("This page lists all the rest apis for Swagger Sample App.")

                .version("1.0-SNAPSHOT")

                .build();

    }

    // Only select apis that matches the given Predicates.

    private Predicate<String> paths() {

    // Match all paths except /error

        return Predicates.and(

        PathSelectors.regex("/.*"), 

        Predicates.not(PathSelectors.regex("/error.*"))

        );

    }

}

3)   API Mapping with Data

@ApiResponses(value = {

@ApiResponse(code = 200, message = "Successful retrieval of user detail",response=DashBoard.class  ),

@ApiResponse(code = 422, message = "Service Error")})

@PostMapping(value = "/dashboard", produces = MediaType.APPLICATION_JSON_VALUE)

public Object test(@RequestBody Message message ,HttpSession session) {//REST Endpoint.

logger.info("hello");

//Message msg = new Message( "Hello " ,"hello111");

String response =  "";

response ="{'user':{'userId':'as','userKey':'tester from service'}}";

return response;

}