springboot配置swagger2

、在pom.xml里添加jar包：

1. <dependency>
2. <groupId>io.springfox</groupId>
3. <artifactId>springfox-swagger-ui</artifactId>
4. <version>${springfox.version}</version>
5. </dependency>
6. <dependency>
7. <groupId>io.springfox</groupId>
8. <artifactId>springfox-swagger2</artifactId>
9. <version>${springfox.version}</version>
10. </dependency>

在pom.xml里的properties里添加版本

1. <properties>
2. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
3. <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
4. <java.version>1.8</java.version>
5. <springfox.version>2.5.0</springfox.version>
6. </properties>

2、在com/demo下创建swagger文件夹，创建SwaggerConfig文件

1. package com.demo.swagger;
2. import org.springframework.context.annotation.Bean;
3. import org.springframework.context.annotation.Configuration;
4. import springfox.documentation.builders.ApiInfoBuilder;
5. import springfox.documentation.builders.PathSelectors;
6. import springfox.documentation.builders.RequestHandlerSelectors;
7. import springfox.documentation.service.ApiInfo;
8. import springfox.documentation.spi.DocumentationType;
9. import springfox.documentation.spring.web.plugins.Docket;
10. import springfox.documentation.swagger2.annotations.EnableSwagger2;
11. /**
12. * Created by huguoju on 2016/12/29.
13. */
14. @Configuration
15. @EnableSwagger2
16. public class SwaggerConfig {
17. /**
18. * 可以定义多个组，比如本类中定义把test和demo区分开了 （访问页面就可以看到效果了）
19. *
20. */
21. @Bean
22. public Docket testApi() {
23. return new Docket(DocumentationType.SWAGGER_2)
24. .apiInfo(apiInfo())
25. .select()
26. .apis(RequestHandlerSelectors.basePackage("com.demo"))
27. .paths(PathSelectors.any()).build();
28. }
29. private ApiInfo apiInfo() {
30. return new ApiInfoBuilder()
31. .title("Spring Boot中使用Swagger2构建RESTful APIs")
32. .description("spring Boot 中构建RESTful API")
33. .termsOfServiceUrl("")
34. .contact("huguoju")
35. .version("1.0")
36. .build();
37. }
38. }

以上就完成了，在页面访问localhost:8080/swagger-ui.html,就看见了，下面主要说说怎么用

1、在com/dem/controller下创建TestController，

1. package com.demo.controller;
2. import com.demo.model.User;
3. import com.demo.service.TestService;
4. import io.swagger.annotations.Api;
5. import io.swagger.annotations.ApiOperation;
6. import io.swagger.annotations.ApiParam;
7. import org.springframework.beans.factory.annotation.Autowired;
8. import org.springframework.http.MediaType;
9. import org.springframework.stereotype.Controller;
10. import org.springframework.web.bind.annotation.RequestMapping;
11. import org.springframework.web.bind.annotation.RequestMethod;
12. import org.springframework.web.bind.annotation.RequestParam;
13. /**
14. * Created by huguoju on 2016/12/28.
15. */
16. @Controller
17. @RequestMapping("test")
18. @Api(value = "测试类",tags = "测试接口")
19. public class TestController {
20. @Autowired
21. private TestService testService;
22. @RequestMapping(value = "testData",produces = MediaType.APPLICATION_JSON_UTF8_VALUE,method = {RequestMethod.POST,RequestMethod.GET})
23. @ApiOperation("测试读写分离")
24. public String testDateSource(
25. @ApiParam(name = "userCode",value = "用户id",required = true)
26. @RequestParam Integer userCode){
27. User user=testService.selectByUserCode(userCode);
28. Integer integer=testService.insertUser(user);
29. return "oo";
30. }
31. }

以上就是controller里主要用到的@Api,  @ApiOperation ,@ApiParam

在model里使用@ApiModelProperty("")

• import com.fasterxml.jackson.annotation.JsonIdentityInfo;
• import io.swagger.annotations.ApiModel;
• import io.swagger.annotations.ApiModelProperty;
• import lombok.Data;
• import org.springframework.stereotype.Component;
• import java.util.Date;
• @Data
• public class User {
• @ApiModelProperty("用户id")
• private Integer userCode;
• @ApiModelProperty("用户类型")
• private String userType;
• @ApiModelProperty("用户名称")
• private String userName;
• @ApiModelProperty("用户手机号")
• private String mobileNumber;
• }