knife4j使用过程

---

前言

Knife4j的前身是swagger-bootstrap-ui。是对swagger进行增强的版本。

---

提示：以下是本篇文章正文内容，下面案例可供参考

一、引入依赖

在pom文件中引入依赖：

<!--knife4j-->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.7</version>
</dependency>
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.7</version>
</dependency>

二、创建config配置文件

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
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.EnableSwagger2WebMvc;

/**
 * <h3>my-blog</h3>
 *
 * @author: GeminiCX
 * @date: 2021-11-02 11:49
 **/

@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {
    
    

    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
    
    
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        //.title("swagger-bootstrap-ui-demo RESTful APIs")
                        .description("# swagger-bootstrap-ui-demo RESTful APIs")
                        .termsOfServiceUrl("http://www.xx.com/")
                        .contact("[email protected]")
                        .version("1.0")
                        .build())
                //分组名称
                .groupName("2.X版本")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.geminicx.myblog"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}

三、编写controller层代码

这里给出个resful风格的demo

import java.util.Arrays;
import java.util.Map;

import com.geminicx.myblog.common.utils.PageUtils;
import com.geminicx.myblog.common.utils.R;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import com.geminicx.myblog.member.entity.UserEntity;
import com.geminicx.myblog.member.service.UserService;


/**
 * @author geminicx
 * @email [email protected]
 * @date 2021-11-02 00:21:36
 */

@Api(tags="用户模块")
@RestController
@RequestMapping("member/user")
public class UserController {
    
    
    @Autowired
    private UserService userService;

    /**
     * 列表
     */
    @GetMapping("/list")
    @ApiImplicitParam(name = "params",value = "传入所需的分页Map参数",required = true)
    @ApiOperation(value="用户列表")
    public R list(@RequestParam(value = "params") Map<String, Object> params){
    
    
        PageUtils page = userService.queryPage(params);

        return R.ok().put("page", page);
    }


    /**
     * 信息
     */
    @GetMapping("/info/{id}")
    @ApiOperation(value="通过id获取用户信息")
    public R info(@PathVariable("id") String id){
    
    
		UserEntity user = userService.getById(id);

        return R.ok().put("user", user);
    }

    /**
     * 保存
     */
    @PostMapping("/save")
    @ApiOperation(value="添加用户")
    public R save(@RequestBody UserEntity user){
    
    
		userService.save(user);

        return R.ok();
    }

    /**
     * 修改
     */
    @PostMapping("/update")
    @ApiOperation(value="更新用户")
    public R update(@RequestBody UserEntity user){
    
    
		userService.updateById(user);

        return R.ok();
    }

    /**
     * 删除
     */
    @DeleteMapping("/delete")
    @ApiOperation(value="删除用户")
    public R delete(@RequestBody String[] ids){
    
    
		userService.removeByIds(Arrays.asList(ids));
        return R.ok();
    }
}

四、页面效果：

总结

给出了简单的Knife4j的使用过程。如果在是微服务架构中，配置类写到common模块的话要使用knife4j的模块记得在该模块的启动类上加入@ComponentScan注解，扫描到配置类。

• 附上knife4j的官方文档的链接：

knife4j官方文档