SpringBoot整合Swagger2简单的例子

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。

这里我给大家带来一个简单的整合DEMO 先来看项目结构

下面是基本的步骤

一.添加MAVEN依赖

1. <dependency>
2. <groupId>io.springfox</groupId>
3. <artifactId>springfox-swagger2</artifactId>
4. <version>2.2.2</version>
5. </dependency>
6. <dependency>
7. <groupId>io.springfox</groupId>
8. <artifactId>springfox-swagger-ui</artifactId>
9. <version>2.2.2</version>
10. </dependency>
11. <dependency>
12. <groupId>org.codehaus.jackson</groupId>
13. <artifactId>jackson-core-asl</artifactId>
14. <version>1.9.13</version>
15. </dependency>

二.编写Swagger配置类

1. @Configuration
2. @EnableSwagger2
3. public class Swaggers {
4. @Bean
5. public Docket swaggerSpringMvcPlugin() {
6. ApiInfo apiInfo = new ApiInfo("sample of springboot", "sample of springboot", null, null, null, null, null);
7. Docket docket = new Docket(DocumentationType.SWAGGER_2).select().paths(regex("/user/.*")).build()
8. .apiInfo(apiInfo).useDefaultResponseMessages(false);
9. return docket;
10. }
11. /*private ApiInfo apiInfo() {
12. return new ApiInfoBuilder().title("测试API")
13. .description("樊亚的测试API1")
14. .version("1.0.0")
15. .build();
16. }*/
17. /* @Bean
18. public Docket createRestApi() {
19. return new Docket(DocumentationType.SWAGGER_2)
20. .apiInfo(apiInfo())
21. .select()
22. .apis(RequestHandlerSelectors.basePackage("com.didispace.web"))
23. .paths(regex("/user/.*"))
24. .build();
25. }
26. */
27. }

当然也可以用链式编程的方法实现，这里我使用的是NEW

三.编写Controller

1. @RestController
2. @RequestMapping("/user")
3. @Api(value = "Shop")
4. public class SpringBootController {
5. @ApiOperation(value = "获取helloWorld", notes = "简单SpringMVC请求")
6. @RequestMapping("/")
7. String home() {
8. return "HELLO WORLD";
9. }
10. @ApiOperation(value = "获得A+B", notes = "根据url的classNo和url的studentName获得请求参数的字符串相加，RestFul风格的请求")
11. @ApiImplicitParams({@ApiImplicitParam(name = "classNo", value = "班级编号", required = true, dataType = "String"),
12. })
13. @RequestMapping(value = "/class/{classNo}/to/{studentName}", method = RequestMethod.GET)
14. String world(@PathVariable("classNo") String classNo, @PathVariable("studentName") String studentName) {
15. return classNo + "  " + studentName;
16. }
17. }

四.编写Application载入类

1. @SpringBootApplication
2. public class Application {
3. public static void main(String[] args) {
4. SpringApplication.run(Application.class,args);
5. }
6. }

Swagger会默认把所有Controller中的RequestMapping方法都生成API出来，实际上我们一般只需要标准接口的（像返回页面的那种Controller方法我们并不需要），所有你可以按下面的方法来设定要生成API的方法的要求。

至此功能基本实现了，我们可以通过访问地址http://localhost:8080/swagger-ui.html/

查看生成好的API

原文地址：https://www.cnblogs.com/wanglei001/p/8329044.html