Swagger入门

在实际项目中，一般使用前后端相分离的项目，在后台测试接口方面可以使用Swagger第三方插件来进行测试。

作者常用测试工具：idea的http client，postman，swagger，浏览器访问（仅支持get，不推荐）

在开发中前台团队要和后台团队有良好的沟通，前台团队向后台团队提要求，例如返回json数据等。

相信无论是前端还是后端开发，都或多或少被接口文档折磨过。前端经常抱怨后端给的接口文档与实际情况不一致。后端又觉得编写及维护接口文档会耗费不少精力，经常来不及更新。其实无论是前端调用后端，还是后端调用后端，都期望有一个好的接口文档。但是这个接口文档对于程序员来说，就跟注释一样，经常会抱怨别人写的代码没有写注释，然而自己写起代码起来，最讨厌的，也是写注释。所以仅仅只通过强制来规范大家是不够的，随着时间推移，版本迭代，接口文档往往很容易就跟不上代码了。

Swagger通过这套规范，你只需要按照它的规范去定义接口及接口相关的信息。再通过Swagger衍生出来的一系列项目和工具，就可以做到生成各种格式的接口文档，生成多种语言的客户端和服务端的代码，以及在线接口调试页面等等。

 搭建环境

1.添加坐标依赖

        
        
            io.springfox
            springfox-swagger2
            2.8.0
        
        
            io.springfox
            springfox-swagger-ui
            2.8.0
        

2.创建配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select()
                .apis(RequestHandlerSelectors.basePackage("cn.pro.demo.controller"))
                .paths(PathSelectors.any())
                .build().apiInfo(new ApiInfoBuilder()
                        .title("智慧景区公共信息云平台后台服务接口列表")
                        .description("服务中心,运营中心等相关接口说明...")
                        .version("1.0")
                        .contact(new Contact("大老板","blog.csdn.net","aaa@gmail.com"))
                        .license("China dci")
                        .licenseUrl("http://www.chinadci.com")
                        .build());
    }

}

3.在对应的controller接口添加注解

@RestController
@Api(tags = "测试springBoot的接口信息管理")
public class TestController {
    @ApiOperation(value = "获取json格式字符串")
    @ApiImplicitParams(@ApiImplicitParam(name = "id",value = "编号"))//如果多个参数逗号隔开
    @GetMapping(value = "/jsonList")
    public List getJson(int id){
        List list = new ArrayList<>();
        list.add("张三");
        list.add("王五");
        list.add("赵六");
        list.add("李七");
        list.add("老八");
        return list;
    }
}

4.在对用的java bean添加注解

@ApiModelProperty(name = "对应属性描述")