springboot集成swagger-白红宇

springboot集成swagger

阅读量：6509 次

发布时间：2019-06-24

本文共 9230 字，大约阅读时间需要 30 分钟。

一、加入依赖


                     
      
       io.springfox
                      
      
       springfox-swagger2
                      
      
       2.7.0
                  
                 
                     
      
       io.springfox
                      
      
       springfox-swagger-ui
                      
      
       2.7.0

二、创建Swagger2配置类

package com.sxdx.oa_service.config;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.web.bind.annotation.RestController;import springfox.documentation.builders.ApiInfoBuilder;import springfox.documentation.builders.PathSelectors;import springfox.documentation.builders.RequestHandlerSelectors;import springfox.documentation.service.ApiInfo;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;import springfox.documentation.swagger2.annotations.EnableSwagger2;@Configuration@EnableSwagger2public class SwaggerConfiguration {    @Bean    public Docket createRestApi() {        return new Docket(DocumentationType.SWAGGER_2)                .apiInfo(apiInfo())                .select()                //.apis(RequestHandlerSelectors.basePackage("com.sxdx.oa_service"))//配置需要生成文档的扫码路径                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))//配置需要生成文档的类型，此处为所有添加了@RestController注解的类                .paths(PathSelectors.any())                .build();    }    private ApiInfo apiInfo() {        return new ApiInfoBuilder()                .title("RESTful APIs")                .description("oa_frame 接口文档")                //.termsOfServiceUrl("http://easonjim.com/")                .contact("高一鹏")                .version("1.0")                .build();    }}

三、代码示例

package com.sxdx.oa_service.springCacheTest.controller;import com.sxdx.oa_service.bootTest.bean.JsonResult;import com.sxdx.oa_service.springCacheTest.model.Department;import com.sxdx.oa_service.springCacheTest.service.CacheTestService;import io.swagger.annotations.Api;import io.swagger.annotations.ApiOperation;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.http.ResponseEntity;import org.springframework.web.bind.annotation.*;@RestController@Api(value = "缓存练习接口",tags = {"缓存练习接口"},description="用于练习spring缓存及redis",hidden = false)public class CacheTestController {    @Autowired    private CacheTestService cacheTestService;    @ApiOperation(            value = "通过id查询部门信息",            notes="通过id查询部门信息")    @GetMapping(value = "selectDeptById/{id}")    public ResponseEntity
     
       selectByPrimaryKey(@PathVariable Integer id){        JsonResult r = new JsonResult();        try {            Department department = cacheTestService.selectByPrimaryKey(id);            r.setResult(department);            r.setStatus("success");        } catch (Exception e) {            r.setResult(e.getClass().getName() + ":" + e.getMessage());            r.setStatus("failure");            e.printStackTrace();        }        return ResponseEntity.ok(r);    }    @ApiOperation(value = "修改部门信息", notes="修改部门信息")    @PostMapping(value = "updateByPrimaryKeySelective")    public ResponseEntity
      
        updateByPrimaryKeySelective(@RequestBody Department dept){        JsonResult r = new JsonResult();        try {            Department department = cacheTestService.updateByPrimaryKeySelective(dept);            r.setResult(department);            r.setStatus("success");        } catch (Exception e) {            r.setResult(e.getClass().getName() + ":" + e.getMessage());            r.setStatus("failure");            e.printStackTrace();        }        return ResponseEntity.ok(r);    }    @ApiOperation(value = "通过id 删除部门", notes="通过id 删除部门")    @GetMapping (value = "deleteDeptById/{id}")    public ResponseEntity
       
         updateByPrimaryKeySelective(@PathVariable Integer id){        JsonResult r = new JsonResult();        try {            int num = cacheTestService.deleteByPrimaryKey(id);            r.setResult("已删除");            r.setStatus("success");        } catch (Exception e) {            r.setResult(e.getClass().getName() + ":" + e.getMessage());            r.setStatus("failure");            e.printStackTrace();        }        return ResponseEntity.ok(r);    }}

四、生成的文档效果（http://127.0.0.1:8080/oaframe/swagger-ui.html）

五、各个注解的介绍（转载自https://www.cnblogs.com/hyl8218/p/8520994.html）

常用到的注解有：

ApiModel

ApiModelProperty

ApiOperation

ApiParam

ApiResponse

ApiResponses

ResponseHeader

1. api标记

Api 用在类上，说明该类的作用。可以标记一个Controller类做为swagger 文档资源，使用方式：

@Api(value = "/user", description = "Operations about user")

与Controller注解并列使用。属性配置：

属性名称	备注
value	url的路径值
tags	如果设置这个值、value的值会被覆盖
description	对api资源的描述
basePath	基本路径可以不配置
position	如果配置多个Api 想改变显示的顺序位置
produces	For example, "application/json, application/xml"
consumes	For example, "application/json, application/xml"
protocols	Possible values: http, https, ws, wss.
authorizations	高级特性认证时配置
hidden	配置为true 将在文档中隐藏

在SpringMvc中的配置如下：

@Controller@RequestMapping(value = "/api/pet", produces = {APPLICATION_JSON_VALUE, APPLICATION_XML_VALUE})@Api(value = "/pet", description = "Operations about pets") public class PetController { }

2. ApiOperation标记

ApiOperation：用在方法上，说明方法的作用，每一个url资源的定义,使用方式：

@ApiOperation(          value = "Find purchase order by ID",          notes = "For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions",          response = Order,          tags = {
       "Pet Store"})

与Controller中的方法并列使用。

属性配置：

属性名称	备注
value	url的路径值
tags	如果设置这个值、value的值会被覆盖
description	对api资源的描述
basePath	基本路径可以不配置
position	如果配置多个Api 想改变显示的顺序位置
produces	For example, "application/json, application/xml"
consumes	For example, "application/json, application/xml"
protocols	Possible values: http, https, ws, wss.
authorizations	高级特性认证时配置
hidden	配置为true 将在文档中隐藏
response	返回的对象
responseContainer	这些对象是有效的 "List", "Set" or "Map".，其他无效
httpMethod	"GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS" and "PATCH"
code	http的状态码默认 200
extensions	扩展属性

在SpringMvc中的配置如下：

@RequestMapping(value = "/order/{orderId}", method = GET)  @ApiOperation(      value = "Find purchase order by ID", notes = "For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions", response = Order.class, tags = { "Pet Store" }) public ResponseEntity
    
      getOrderById(@PathVariable("orderId") String orderId) throws NotFoundException { Order order = storeData.get(Long.valueOf(orderId)); if (null != order) { return ok(order); } else { throw new NotFoundException(404, "Order not found"); } }

3. ApiParam标记

ApiParam请求属性,使用方式：

public ResponseEntity
    
      createUser(@RequestBody @ApiParam(value = "Created user object", required = true)  User user)

与Controller中的方法并列使用。

属性配置：

属性名称	备注
name	属性名称
value	属性值
defaultValue	默认属性值
allowableValues	可以不配置
required	是否属性必填
access	不过多描述
allowMultiple	默认为false
hidden	隐藏该属性
example	举例子

在SpringMvc中的配置如下：

public ResponseEntity
    
      getOrderById(      @ApiParam(value = "ID of pet that needs to be fetched", allowableValues = "range[1,5]", required = true)      @PathVariable("orderId") String orderId)

4. ApiResponse

ApiResponse：响应配置，使用方式：

@ApiResponse(code = 400, message = "Invalid user supplied")

与Controller中的方法并列使用。属性配置：

属性名称	备注
code	http的状态码
message	描述
response	默认响应类 Void
reference	参考ApiOperation中配置
responseHeaders	参考 ResponseHeader 属性配置说明
responseContainer	参考ApiOperation中配置

在SpringMvc中的配置如下：

@RequestMapping(value = "/order", method = POST)  @ApiOperation(value = "Place an order for a pet", response = Order.class) @ApiResponses({ @ApiResponse(code = 400, message = "Invalid Order") }) public ResponseEntity
    
      placeOrder( @ApiParam(value = "order placed for purchasing the pet", required = true) Order order) { storeData.add(order); return ok(""); }

5. ApiResponses

ApiResponses：响应集配置，使用方式：

@ApiResponses({ @ApiResponse(code = 400, message = "Invalid Order") })

与Controller中的方法并列使用。属性配置：

属性名称	备注
value	多个ApiResponse配置

在SpringMvc中的配置如下：

@RequestMapping(value = "/order", method = POST)  @ApiOperation(value = "Place an order for a pet", response = Order.class) @ApiResponses({ @ApiResponse(code = 400, message = "Invalid Order") }) public ResponseEntity
    
      placeOrder( @ApiParam(value = "order placed for purchasing the pet", required = true) Order order) { storeData.add(order); return ok(""); }

6. ResponseHeader

响应头设置，使用方法

@ResponseHeader(name="head1",description="response head conf")

与Controller中的方法并列使用。属性配置：

属性名称	备注
name	响应头名称
description	头描述
response	默认响应类 Void
responseContainer	参考ApiOperation中配置

在SpringMvc中的配置如下：

@ApiModel(description = "群组")

7. 其他

@ApiImplicitParams：用在方法上包含一组参数说明；

@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
- paramType：参数放在哪个地方
- name：参数代表的含义
- value：参数名称
- dataType：参数类型，有String/int，无用
- required ：是否必要
- defaultValue：参数的默认值