0209_【理解】REST接口描述

1、
package com.yootk.provider.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;

import springfox.documentation.builders.PathSelectors;

import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class SwaggerConfig { // Swagger配置类

 private ApiInfo getApiInfo() { // 文档之中的头部的信息项

return new ApiInfoBuilder().title("【沐言科技】部门微服务")

 　　　　　　　　.description("实现部门数据的统一管理，包括：增加部门信息、查询部门信息、部门列表显示等，此处省略5000字...")

　　　　　　　　  .termsOfServiceUrl("https://www.xxxx.com")

　　　　　　　　.contact(new Contact("xxxx老师", "edu.xxx.com", "[email protected]"))

 　　　　　　　　.license("xxxx - 授权管理").version("1.0.0").build();

}

@Bean
public Docket getDocker() { // 所有的详细描述在此类中定义

return new Docket(DocumentationType.SWAGGER_2) // 使用的文档版本类型

　　.apiInfo(this.getApiInfo())

　　 .select() // 所有的接口一定要放在指定的包中

　　.apis(RequestHandlerSelectors.basePackage("com.yootk.provider.action"))
　　.paths(PathSelectors.any()).build();

}

}

2、
package com.yootk.provider.action;

import com.yootk.common.dto.DeptDTO;
import com.yootk.service.IDeptService;

import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;

import lombok.extern.slf4j.Slf4j;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.util.Enumeration;

@RestController
@RequestMapping("/provider/dept/*") // 微服务提供者父路径
@Slf4j // 使用一个注解

public class DeptAction {

@Autowired
private IDeptService deptService;

 @ApiOperation(value="部门查询", notes = "根据部门编号查询部门详细信息")

  @GetMapping("get/{id}")

@ApiOperation(value="部门增加", notes = "增加新的部门信息")
@ApiImplicitParams({@ApiImplicitParam(name = "deptDTO", required = true,dataType = "DeptDTO", value = "部门传输对象实例") })
@PostMapping("add")

public Object add(@RequestBody DeptDTO deptDTO) { // 后面会修改参数模式为JSON
　　this.printRequestHeaders("add");
　　return this.deptService.add(deptDTO);
}

@ApiOperation(value="部门列表", notes = "查询部门的完整信息")
@GetMapping("list")

public Object list() {
　　this.printRequestHeaders("list");
　　return this.deptService.list();
}

@ApiOperation(value="部门分页查询", notes = "根据指定的数据库参数实现部门数据的分页加载")
@ApiImplicitParams({
@ApiImplicitParam(name="cp", value = "当前所在页", required = true, dataType = "int"),
@ApiImplicitParam(name="ls", value = "每页显示的数据行数", required = true, dataType = "int"),
@ApiImplicitParam(name="col", value = "模糊查询列", required = true, dataType = "String"),
@ApiImplicitParam(name="kw", value = "模糊查询关键字", required = true, dataType = "String")
})
@GetMapping("split")

public Object split(int cp, int ls, String col, String kw) {
　　this.printRequestHeaders("split");
　　return this.deptService.split(cp, ls, col, kw);
}

  private void printRequestHeaders(String restName) {    // 实现所有请求头信息的输出　　

　　HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
　　Enumeration<String> headerEnums = request.getHeaderNames();
　　while (headerEnums.hasMoreElements()) {
　　　　String headerName = headerEnums.nextElement();
　　　　log.info("【{}】头信息：{} = {}", restName, headerName, request.getHeader(headerName));
　　}

}

}