1. First of all we need to add swagger dependency in our spring boot application.<\/p>\n
if you are using gradle as build tool then you need to add following dependency in your build file<\/p>\n
'com.mangofactory:swagger-springmvc:1.0.2'\r\n<\/pre>\nand for maven project you need to add following dependency in our build xml file:-<\/p>\n
\r\n<dependency>\r\n <groupId>com.mangofactory<\/groupId>\r\n <artifactId>swagger-springmvc<\/artifactId>\r\n <version>1.0.2<\/version>\r\n<dependency>\r\n<\/pre>\n2. Then we need to add a java class that enables the swagger into action.<\/p>\n
[code]
\npackage com.intelligrape.com.config;<\/p>\nimport com.mangofactory.swagger.configuration.SpringSwaggerConfig;
\nimport com.mangofactory.swagger.models.dto.ApiInfo;
\nimport com.mangofactory.swagger.plugin.EnableSwagger;
\nimport com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin;
\nimport org.springframework.beans.factory.annotation.Autowired;
\nimport org.springframework.boot.autoconfigure.EnableAutoConfiguration;
\nimport org.springframework.context.annotation.Bean;
\nimport org.springframework.context.annotation.Configuration;<\/p>\n@Configuration
\n@EnableSwagger
\n@EnableAutoConfiguration
\npublic class SwaggerConfig {<\/p>\nprivate SpringSwaggerConfig springSwaggerConfig;<\/p>\n
@Autowired
\n public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig) {
\n this.springSwaggerConfig = springSwaggerConfig;
\n }<\/p>\n@Bean
\n public SwaggerSpringMvcPlugin customImplementation() {
\n return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
\n .apiInfo(new ApiInfo(
\n "SWAGGER DEMO WITH SPRING BOOT REST API",
\n "This API is for swagger demo person analysis.",
\n null,
\n null,
\n null,
\n null
\n ))
\n \/\/Here we disable auto generating of responses for REST-endpoints
\n .useDefaultResponseMessages(false)
\n \/\/Here we specify URI patterns which will be included in Swagger docs. Use regex for this purpose.
\n .includePatterns("\/swagger-demo\/.*");
\n }<\/p>\n}
\n[\/code]<\/p>\nNote<\/strong>: you have to add swagger configuration class in the application classpath so that it will be scan by compiler at run time.<\/p>\n
3. After the configuration file is done we can jump on to Controllers.<\/p>\n
[code]
\npackage com.intelligrape.com.person<\/p>\nimport com.wordnik.swagger.annotations.Api
\nimport com.wordnik.swagger.annotations.ApiOperation
\nimport com.wordnik.swagger.annotations.ApiResponse
\nimport com.wordnik.swagger.annotations.ApiResponses
\nimport org.springframework.http.HttpStatus
\nimport org.springframework.http.MediaType
\nimport org.springframework.http.ResponseEntity
\nimport org.springframework.web.bind.annotation.*<\/p>\n\/**
\n * Created by Ashu on 2\/7\/15.
\n *\/<\/p>\n@Api(basePath = "swagger-demo\/person", value = "Person", description = "Operations with person", produces = "application\/json")
\n@RestController
\n@RequestMapping(value = "swagger-demo\/person", produces = MediaType.APPLICATION_JSON_VALUE)
\nclass PersonController {<\/p>\n@RequestMapping(method = RequestMethod.POST, value = "\/create")
\n @ResponseStatus(HttpStatus.NOT_FOUND)
\n @ApiOperation(value = "Get Person", notes = "Fetch List of Person")
\n @ApiResponses(value = [
\n @ApiResponse(code = 400, message = "Fields are with validation errors"),
\n @ApiResponse(code = 201, message = "List"),
\n @ApiResponse(code = 500, message = "Error occurred while fetching Person")
\n ])
\n ResponseEntity create(@RequestBody PersonCO co) {
\n return new ResponseEntity(new Person(firstName: co.firstName, lastName: co.lastName, age: co.age), HttpStatus.OK)
\n }
\n}
\n[\/code]<\/p>\n
![\"rsz_swagger\"](\"\/blog\/wp-ttn-blog\/uploads\/2015\/07\/rsz_swagger.png\")
<\/p>\n