在spring boot项目中应用swagger2

1.       在pom.xml中添加
<dependency>

      <groupId>io.springfox</groupId>

      <artifactId>springfox-swagger2</artifactId>

      <version>2.6.1</version>

   </dependency>

   <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->

   <dependency>

      <groupId>io.springfox</groupId>

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

      <version>2.6.1</version>

   </dependency>

2.       在SpringBoot Application同级添加一个Swagger config的类，随意命名，示例代码如下：

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.ComponentScan;

import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;

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

@ComponentScan("com.onCloud.yukechina.web")

public class SwaggerConfigAPI {

   @Bean

   public Docket createRestApi(){

      return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());

   }

   private ApiInfo apiInfo(){

      return new ApiInfoBuilder().title("salesforce转发服务器").description("接收云科数据，并将数据转发到salsesforce").termsOfServiceUrl("www.yunkechina.com").version("salse").build();

   }

}

3.       最后在扫描的包中注释要生成API文档的类，如下：

@RestController

public class SampleController {

 

       @RequestMapping("/")

       @ApiOperation(value="欢迎页面",httpMethod="GET",notes="欢迎界面",produces=MediaType.APPLICATION_JSON_UTF8_VALUE)

       String home() {

          return "Wellcome";

       }

}

4.启动spring boot 在浏览器中访问http://localhost:80/swagger-ui.html