【Java项目中使用Swagger生成接口文档】

今天主要分享下一个用于管理、测试项目接口的技术Swagger，它会生成项目中所有接口信息生成接口文档，以及提供在线接口调试界面。

---

第一步：引入依赖

导入knife4j的maven坐标。

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>knife4j-spring-boot-starter</artifactI
   <version>${knife4j}</version>
</dependency>

第二步：在配置类中加入knife4j相关配置
在一个@Configuration对象中加入一个新的@Bean注解，以我的项目为例：下面这个配置是将项目中的controller层的管理端的接口进行生成文档。

由于项目存在管理员端跟用户端，可以将对应接口分开，使用groupName进行区分。如下：

第三步： 设置静态资源映射，让上面这两个Bean生效，并设置访问路径。

protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

相关接口代码：

效果展示：

总结：可以看出Swagger生成的接口文档通俗易懂，根据配置类对不同端的用户进行接口分类，然后@Api设置接口名称，@ApiOperation设置具体方法的名称。还可以在接口文档中进行调试。