Springboot(二) 接口调试之swagger

1、接口调试

起初对于项目的API接口都是使用Postman进行测试，感觉一切顺利妥当，但是随着项目的深入，每个测试的人都需要安装一个postman插件或者其他下载其他小软件进行测试总是显得麻烦。而且在项目中需要同时兼容https（带有安全加密的超文本传输协议）和http（超文本传输协议）两种协议的接口时，本人使用postman一直无法完成测试，很是郁闷，在同事的帮助下了解了swagger。

Swagger的说明简介参考文章： Swagger简介

通俗的来说，就是在项目运行后，直接通过在地址栏输入:
https://localhost:8043/swagger-ui.html 就可以进行端口测试。

• https : 我使用的协议，如果使用的是http，那就填写http；
• localhost：表示本地地址，如果在阿里云之类的服务器上也可以填写对应的ip地址；
• 8043：是我配置的https的协议的端口号，可以修改；
• swagger-ui.html：这个是固定的，引入到项目中部分，在这个界面上可以进行参数调试，如下图：

---

在该页面下可以进行不同接口的调试，直接输入参数就可以实现黑盒测试。

2、配置方式

知道了大概是做什么的，那我们需要知道我该如何将其配置到我的项目中呢？其实挺简单的，下面来一一解释该如何操作。

• 1，在maven repository中查找swagger的maven或者gradle或者其他的依赖方式。分别添加到pom.xml文件中或者build.gradle中。

dependencies {
    compile group: 'io.springfox', name: 'springfox-swagger2', version: '2.6.0'
    compile group: 'io.springfox', name: 'springfox-swagger-ui', version: '2.6.0'
    }

添加到build.gradle中一定要更新下gradle，不然这些依赖可能不在本地。

---

• 2，代码配置
  SwaggerConfig.java文件

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

import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

这样就配置完成了，启动项目，在地址栏输入http(s)://localhost:8043/swagger-ui.html即可。
如果需要header的参数，需要在controller中添加一个标签就可以。如图：

下次再详细介绍下代码配置部分的含义。