swagger2的使用

之前在springboot或者springmvc的不同项目中使用过swagger2，觉得大同小异，基本流程和思想都是一样的。（就像我们学习一种新技术时，了解其思想可能比会做更重要。）

以下开始说明使用swagger2的流程及思想：

（1）pom.xml中添加依赖（这里使用的是已经集成的springfox-swagger2，传统上使用swagger2需要添加一系列的依赖，然后得到一个不太友好的json格式的内容展示在页面上，swagger2推荐使用其swagger-ui（需要官网上下载此包解压）来解析得到的json格式来展现出一个比较友好的页面，而这一切都已经被springfox-swagger2包含在内）

         
            io.springfox
            springfox-swagger2
            2.5.0
       
       
            io.springfox
            springfox-swagger-ui
            2.5.0

       

（2）配置Swagger类（更多配置可自行百度）

@Configuration
public class Swagger {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
.apis(RequestHandlerSelectors.basePackage("这里是需要扫描接口的包路径")).paths(PathSelectors.any()).build();
}

private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("api名称").version("版本号").build();
}

}

（3）开始愉快的使用swagger2

@Api(value = "test", tags = "test")
@RestController
@RequestMapping("/api/test")
public class Tets {
@ApiOperation(value = "接口说明", notes = "接口说明")
@ApiImplicitParams({ @ApiImplicitParam(name = "id", value = "这是id"), @ApiImplicitParam(name = "name", value = "这是name") })
@RequestMapping(value = "/test", method = { RequestMethod.GET, RequestMethod.POST })
public String test(@RequestParam(value = "id", required = true) String id,@RequestParam(value = "name", required = true) String name) {
return id+name;
}

}

最后访问swagger查看api文档：通过ip+端口+/swagger-ui.html#/