Spring MVC中使用 Swagger2 构建Restful API

1.Spring MVC配置文件中的配置

[java] view plain copy

1. <!-- 设置使用注解的类所在的jar包，只加载controller类 -->
2. <context:component-scan base-package="com.jay.plat.config.controller" />

[java] view plain copy

1. <!-- 使用 Swagger Restful API文档时，添加此注解 -->
2. <mvc:default-servlet-handler />

1. <mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/"/>
2. <mvc:resources mapping="/webjars/**" location="classpath:/META-INF/resources/webjars/"/>

2.maven依赖

[html] view plain copy

1. <!-- 构建Restful API -->
2. <dependency>
3. <groupId>io.springfox</groupId>
4. <artifactId>springfox-swagger2</artifactId>
5. <version>2.4.0</version>
6. </dependency>
7. <dependency>
8. <groupId>io.springfox</groupId>
9. <artifactId>springfox-swagger-ui</artifactId>
10. <version>2.4.0</version>
11. </dependency>

3.Swagger配置文件

[java] view plain copy

1. package com.jay.plat.config.util;
2. import org.springframework.context.annotation.Bean;
3. import org.springframework.context.annotation.ComponentScan;
4. import org.springframework.context.annotation.Configuration;
5. import org.springframework.web.servlet.config.annotation.EnableWebMvc;
6. import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
7. import springfox.documentation.builders.ApiInfoBuilder;
8. import springfox.documentation.builders.PathSelectors;
9. import springfox.documentation.builders.RequestHandlerSelectors;
10. import springfox.documentation.service.ApiInfo;
11. import springfox.documentation.spi.DocumentationType;
12. import springfox.documentation.spring.web.plugins.Docket;
13. import springfox.documentation.swagger2.annotations.EnableSwagger2;
14. /*
15. * Restful API 访问路径:
16. * http://IP:port/{context-path}/swagger-ui.html
17. * eg:http://localhost:8080/jd-config-web/swagger-ui.html
18. */
19. @EnableWebMvc
20. @EnableSwagger2
21. @ComponentScan(basePackages = {"com.plat.config.controller"})
22. @Configuration
23. public class RestApiConfig extends WebMvcConfigurationSupport{
24. @Bean
25. public Docket createRestApi() {
26. return new Docket(DocumentationType.SWAGGER_2)
27. .apiInfo(apiInfo())
28. .select()
29. .apis(RequestHandlerSelectors.basePackage("com.jay.plat.config.controller"))
30. .paths(PathSelectors.any())
31. .build();
32. }
33. private ApiInfo apiInfo() {
34. return new ApiInfoBuilder()
35. .title("Spring 中使用Swagger2构建RESTful APIs")
36. .termsOfServiceUrl("http://blog.csdn.net/he90227")
37. .contact("逍遥飞鹤")
38. .version("1.1")
39. .build();
40. }
41. }

配置说明：

[html] view plain copy

1. @Configuration 配置注解，自动在本类上下文加载一些环境变量信息
2. @EnableWebMvc
3. @EnableSwagger2 使swagger2生效
4. @ComponentScan("com.myapp.packages") 需要扫描的包路径

4.Controller中使用注解添加API文档

[java] view plain copy

1. package com.jay.spring.boot.demo10.swagger2.controller;
2. import java.util.ArrayList;
3. import java.util.Collections;
4. import java.util.HashMap;
5. import java.util.List;
6. import java.util.Map;
7. import org.springframework.web.bind.annotation.PathVariable;
8. import org.springframework.web.bind.annotation.RequestBody;
9. import org.springframework.web.bind.annotation.RequestMapping;
10. import org.springframework.web.bind.annotation.RequestMethod;
11. import org.springframework.web.bind.annotation.RestController;
12. import com.jay.spring.boot.demo10.swagger2.bean.User;
13. import io.swagger.annotations.ApiImplicitParam;
14. import io.swagger.annotations.ApiImplicitParams;
15. import io.swagger.annotations.ApiOperation;
16. @RestController
17. @RequestMapping(value = "/users") // 通过这里配置使下面的映射都在/users下，可去除
18. public class UserController {
19. static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>());
20. @ApiOperation(value = "获取用户列表", notes = "")
21. @RequestMapping(value = { "" }, method = RequestMethod.GET)
22. public List<User> getUserList() {
23. List<User> r = new ArrayList<User>(users.values());
24. return r;
25. }
26. @ApiOperation(value = "创建用户", notes = "根据User对象创建用户")
27. @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
28. @RequestMapping(value = "", method = RequestMethod.POST)
29. public String postUser(@RequestBody User user) {
30. users.put(user.getId(), user);
31. return "success";
32. }
33. @ApiOperation(value = "获取用户详细信息", notes = "根据url的id来获取用户详细信息")
34. @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
35. @RequestMapping(value = "/{id}", method = RequestMethod.GET)
36. public User getUser(@PathVariable Long id) {
37. return users.get(id);
38. }
39. @ApiOperation(value = "更新用户详细信息", notes = "根据url的id来指定更新对象，并根据传过来的user信息来更新用户详细信息")
40. @ApiImplicitParams({ @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long"),
41. @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User") })
42. @RequestMapping(value = "/{id}", method = RequestMethod.PUT)
43. public String putUser(@PathVariable Long id, @RequestBody User user) {
44. User u = users.get(id);
45. u.setName(user.getName());
46. u.setAge(user.getAge());
47. users.put(id, u);
48. return "success";
49. }
50. @ApiOperation(value = "删除用户", notes = "根据url的id来指定删除对象")
51. @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
52. @RequestMapping(value = "/{id}", method = RequestMethod.DELETE)
53. public String deleteUser(@PathVariable Long id) {
54. users.remove(id);
55. return "success";
56. }
57. }

5.效果展示

访问路径：

[java] view plain copy

1. Restful API 访问路径:
2. * http://IP:port/{context-path}/swagger-ui.html
3. * eg:http://localhost:8080/jd-config-web/swagger-ui.html

参考：

http://www.cnblogs.com/yuananyun/p/4993426.html

http://www.jianshu.com/p/8033ef83a8ed

来源：http://blog.csdn.net/phantomes/article/details/52334591

来自为知笔记(Wiz)