【 转载请注明 】:
原文出处: https://www.cnblogs.com/jstarseven/p/11509884.html 作者 :jstarseven 码字挺辛苦的.....
Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的web服务。目标是使客户端和文件系统作为服务器以同样的速度来更新文件的方法,参数和模型紧密集成到服务器。这个解释简单点来讲就是说,swagger是一款可以根据restful风格生成的接口开发文档,并且支持做测试的一款中间软件。
1 <?xml version="1.0" encoding="UTF-8"?> 2 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 3 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 4 <modelVersion>4.0.0</modelVersion> 5 <parent> 6 <groupId>org.springframework.boot</groupId> 7 <artifactId>spring-boot-starter-parent</artifactId> 8 <version>2.1.3.RELEASE</version> 9 <relativePath/> 10 </parent> 11 <groupId>com.dds.sbswagger</groupId> 12 <artifactId>sb-swagger</artifactId> 13 <version>0.0.1-SNAPSHOT</version> 14 <name>sb-swagger</name> 15 <description>Demo project for Spring Boot</description> 16 17 <properties> 18 <java.version>1.8</java.version> 19 </properties> 20 <dependencies> 21 <dependency> 22 <groupId>org.springframework.boot</groupId> 23 <artifactId>spring-boot-starter-web</artifactId> 24 </dependency> 25 <dependency> 26 <groupId>org.springframework.boot</groupId> 27 <artifactId>spring-boot-starter-test</artifactId> 28 <scope>test</scope> 29 </dependency> 30 <dependency> 31 <groupId>io.springfox</groupId> 32 <artifactId>springfox-swagger2</artifactId> 33 <version>2.9.2</version> 34 </dependency> 35 <dependency> 36 <groupId>io.springfox</groupId> 37 <artifactId>springfox-swagger-ui</artifactId> 38 <version>2.9.2</version> 39 </dependency> 40 <dependency> 41 <groupId>org.projectlombok</groupId> 42 <artifactId>lombok</artifactId> 43 <version>1.18.6</version> 44 </dependency> 45 </dependencies> 46 <build> 47 <plugins> 48 <plugin> 49 <groupId>org.springframework.boot</groupId> 50 <artifactId>spring-boot-maven-plugin</artifactId> 51 </plugin> 52 </plugins> 53 </build> 54 </project>
1 package com.dds.sbswagger; 2 3 import lombok.extern.slf4j.Slf4j; 4 import org.springframework.boot.SpringApplication; 5 import org.springframework.boot.autoconfigure.SpringBootApplication; 6 7 /** 8 * @author dds 9 */ 10 @SpringBootApplication 11 @Slf4j 12 public class SbSwaggerApplication { 13 14 public static void main(String[] args) { 15 SpringApplication.run(SbSwaggerApplication.class, args); 16 log.info("/n----------------------------------------------------------/n/t" + 17 "Application demo is running! Access URLs:/n/t" + 18 "swagger-ui: /thttp://127.0.0.1:8080/swagger-ui.html/n/t" + 19 "----------------------------------------------------------"); 20 } 21 22 }
1 package com.dds.sbswagger.config; 2 3 import io.swagger.annotations.ApiOperation; 4 import org.springframework.context.annotation.Bean; 5 import org.springframework.context.annotation.Configuration; 6 import springfox.documentation.builders.PathSelectors; 7 import springfox.documentation.builders.RequestHandlerSelectors; 8 import springfox.documentation.service.ApiInfo; 9 import springfox.documentation.service.Contact; 10 import springfox.documentation.spi.DocumentationType; 11 import springfox.documentation.spring.web.plugins.Docket; 12 import springfox.documentation.swagger2.annotations.EnableSwagger2; 13 14 import java.util.Collections; 15 16 /** 17 * @author DDS 18 * @date 2019/9/10 13:55 19 */ 20 @Configuration 21 @EnableSwagger2 22 public class SwaggerConfig { 23 @Bean 24 public Docket api() { 25 return new Docket(DocumentationType.SWAGGER_2) 26 .select() 27 .apis(RequestHandlerSelectors.basePackage("com.dds.sbswagger.controller")) 28 //加了ApiOperation注解的类,才生成接口文档 29 .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) 30 .paths(PathSelectors.any()) 31 .build() 32 .apiInfo(apiInfo()); 33 } 34 35 private ApiInfo apiInfo() { 36 return new ApiInfo( 37 "Spring Boot项目集成Swagger实例文档", 38 "我的微信公众号:大道七哥,欢迎大家关注。", 39 "API V1.0", 40 "Terms of service", 41 new Contact("大道七哥", "https://www.cnblogs.com/jstarseven/", "jstarseven@163.com"), 42 "Apache", "http://www.apache.org/", Collections.emptyList()); 43 } 44 }
1 package com.dds.sbswagger.model; 2 3 import io.swagger.annotations.ApiModel; 4 import io.swagger.annotations.ApiModelProperty; 5 import lombok.Data; 6 7 /** 8 * @author DDS 9 * @date 2019/9/10 13:55 10 */ 11 @ApiModel("用户实体") 12 @Data 13 public class User { 14 15 /** 16 * 用户Id 17 */ 18 @ApiModelProperty("用户id") 19 private int id; 20 21 /** 22 * 用户名 23 */ 24 @ApiModelProperty(value = "用户姓名", example = "zhangdan", required = true) 25 private String name; 26 27 /** 28 * 用户地址 29 */ 30 @ApiModelProperty(value = "用户地址", example = "北京市海淀区", required = true) 31 private String address; 32 33 /** 34 * 用户手机号 35 */ 36 @ApiModelProperty(value = "用户手机号", example = "15689652367", required = true) 37 private String phone; 38 39 /** 40 * 用户年龄 41 */ 42 @ApiModelProperty(value = "用户年龄", example = "24", required = true) 43 private Integer age; 44 45 }
1 package com.dds.sbswagger.controller; 2 3 import com.dds.sbswagger.model.User; 4 import io.swagger.annotations.*; 5 import org.springframework.web.bind.annotation.*; 6 7 /** 8 * @author DDS 9 * @date 2019/9/10 13:55 10 */ 11 @RestController 12 @RequestMapping("/user") 13 @Api(tags = "用户相关接口", description = "提供用户相关的Rest API") 14 public class UserController { 15 16 @PostMapping("/add") 17 @ApiOperation(value = "新增用户接口", notes = "手机号、密码都是必输项,年龄随边填,但必须是数字") 18 @ApiImplicitParams({ 19 @ApiImplicitParam(name = "name", value = "用户名称", required = true, paramType = "form"), 20 @ApiImplicitParam(name = "address", value = "用户地址", required = true, paramType = "form"), 21 @ApiImplicitParam(name = "phone", value = "用户手机号", required = true, paramType = "form"), 22 @ApiImplicitParam(name = "age", value = "用户年龄", required = true, paramType = "form", dataType = "Integer") 23 }) 24 public boolean addUser(@RequestBody User user) { 25 return false; 26 } 27 28 @ApiOperation("通过id查找用户接口") 29 @GetMapping("/find/{id}") 30 public User findById(@PathVariable("id") int id) { 31 return new User(); 32 } 33 34 @ApiOperation("更新用户信息接口") 35 @PutMapping("/update") 36 @ApiResponses({ 37 @ApiResponse(code = 400, message = "请求参数没填好"), 38 @ApiResponse(code = 404, message = "请求路径没有或页面跳转路径不对"), 39 @ApiResponse(code = 405, message = "未知错误") 40 }) 41 public boolean update(@RequestBody User user) { 42 return true; 43 } 44 45 @ApiOperation("删除用户接口") 46 @DeleteMapping("/delete/{id}") 47 public boolean delete(@PathVariable("id") int id) { 48 return true; 49 } 50 }