超简单的springboot+swagger2实现在线接口调试

发布时间：2020-07-12 09:02:16 作者：seallydeng
来源：网络阅读：1560

前言：

作为标标准准的后台开发攻城狮，在于前端交互给其提供接口的时候，是不是要给其准备接口文档？是不是在和他联调之前首先要自测通过呢？是不是自测之前要写接口调用（比如postman）呢？作为一个负责滴、追求向上滴工程师，那这些肯定是要做的。事情都要做，可做事的方式不同，结果和效率也不同，那么下面和大家分享一下springboot项目中提供的接口如何方便快捷提供一种自测，甚至是直接给接口测试人员测试的方式，那就是整合进去seagger2.用了还想用的第三方插件吧，

申明：

我不喜欢文章很复杂，追求简而美观的实用性，但是为了需要的伙伴能够直接一步到位，绝对可用，所以直接粘贴的核心代码，方便你们复制过去，因此给文章增加了看起来不太友好的复杂度。

开发环境：

1、添加依赖

这里默认我们已使用的maven项目，否则的话请自行下载依赖相关的java包也一样，项目引入以下依赖：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

2、添加配置类

package cn.seally.community.config;
import static com.google.common.base.Predicates.or;
import static springfox.documentation.builders.PathSelectors.regex;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.google.common.base.Predicate;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* @Description swagger在线接口插件配置类
* @Date 2019年8月31日
* @author seallydeng
*/
@Configuration
@EnableSwagger2 //开启在线接口文档
public class SwaggerConfig {

    /**
     * @Description
     * @Date 2019年8月31日
     * @author seallydeng
     * @return
     */
    @Bean
    public Docket controllerApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("标题：Seally Web 接口文档")//标题
                        .description("本系统接口主要包括xxx、yyy等功能模块")//描述
                        .contact(new Contact("dningcheng", "http://www.xxx.com/web", "dningcheng@163.com"))
                        .version("1.0.0")//版本号
                        .build())
                .select()
                .apis(RequestHandlerSelectors.basePackage("cn.seally.community.controller"))//配置扫描的控制器类包
                .paths(paths())//配置符合指定规则的路径接口才生成在线接口，用于定制那些接口在ui中展示
                .build();
    }

    @SuppressWarnings("unchecked")
   private Predicate<String> paths() {
    return or(regex("/user/api/.*?"));
}
}

3、控制器以注解方式增加接口描述信息

package cn.seally.community.controller;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import cn.seally.community.common.ApiResponse;
import cn.seally.community.model.base.SystemUser;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
/**
* @Description 用于演示swagger在线接口文档的控制器
* @Date 2019年8月31日
* @author seallydeng
*/
@Api(tags={"系统首页热点图相关接口"}) //标注在类上：用以备注接口组名称
@RestController
@RequestMapping("/demo")
public class DemoController {

@ApiOperation(value="获取用户信息",notes="username是唯一属性，单个用户可直接通过username获取") //标注在方法：用以备注接口描述
@GetMapping(value="/user/query")
public ApiResponse<String> getUserInfo(String username){
  return ApiResponse.success("获取信息通过");
}

@PostMapping(value="/user/save",produces="application/json")
public ApiResponse<String> saveUserInfo(@RequestBody SystemUser user){
  return ApiResponse.success("保存用户信息成功");
}

@PutMapping(value="/user/update",produces="application/json")
public ApiResponse<String> updateUserInfo(@RequestBody SystemUser user){
  return ApiResponse.success("修改用户信息成功");
}

@DeleteMapping(value="/user/delete/{username}",produces="application/json")
public ApiResponse<String> deleteUserInfo(@PathVariable("username") String username){
  return ApiResponse.success("删除用户信息成功");
}
}