knife4j使用

knife4j使用

1、导入依赖：

<!--接口文档生成依赖-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
        </dependency>

2、配置

package com.guigu.config.knife4jconfig;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

import java.util.ArrayList;
import java.util.List;

/**
 * knife4j接口文档配置信息
 */
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfig {

    @Bean
    public Docket adminApiConfig(){
        List<Parameter> pars = new ArrayList<>();
        ParameterBuilder tokenPar = new ParameterBuilder();
        tokenPar.name("token")
                .description("用户token")
                .defaultValue("")
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .required(false)
                .build();
        pars.add(tokenPar.build());
        //添加head参数end

        Docket adminApi = new Docket(DocumentationType.SWAGGER_2)
                .groupName("adminApi")
                .apiInfo(adminApiInfo())
                .select()
                //只显示admin路径下的页面
                .apis(RequestHandlerSelectors.basePackage("com.wenxue"))
                .paths(PathSelectors.regex("/admin/.*"))
                .build()
                .globalOperationParameters(pars);
        return adminApi;
    }

    private ApiInfo adminApiInfo(){

        return new ApiInfoBuilder()
                .title("后台管理系统-API文档")
                .description("本文档描述了后台管理系统微服务接口定义")
                .version("1.0")
                .contact(new Contact("wenxue", "http://wenxue.com", "wenxue@qq.com"))
                .build();
    }

}

3、controller层使用

//接口测试路径http://localhost:8800/doc.html
@Api(tags = "后台登录管理")
@Slf4j
@RestController
@RequestMapping("/admin/system/index")
public class LoginController {
    @Autowired
    private SysUserService sysUserService;

    @Autowired
    private SysMenuService sysMenuService;

    /**
     * 登录生成token,并返回token
     * @return
     */
    @ApiOperation("登录")
    @PostMapping("login")
    public Result login(@RequestBody LoginVo loginVo) {
        //1.获取用户名
        String username = loginVo.getUsername();
        log.info(username + "用户登录请求!");

        //2.查询数据库
        LambdaQueryWrapper<SysUser> wrapper = new LambdaQueryWrapper<>();
        wrapper.eq(SysUser::getUsername,username);

        //2.1获取唯一一个值
        SysUser sysUser = sysUserService.getOne(wrapper);

        //3.用户信息是否存在
        if(sysUser == null){
            throw new GuiguException(210,"用户不存在!");
        }

        //4.判断密码
        //将获取的密码进行md5加密处理
        String password = loginVo.getPassword();
        String md5PassWord = DigestUtils.md5DigestAsHex(password.getBytes());

        //数据库中的密码是经过md5加密处理的
        if(!md5PassWord.equals(sysUser.getPassword())){
            throw new GuiguException(201,"密码错误!");
        }

        //5.判断用户是否被禁用
        if(sysUser.getStatus() == 0 ){
            throw new GuiguException(201,"用户已被禁用!");
        }
        //6.使用jwt根据用户id和用户名生成token字符串
        String token = JwtHelper.createToken(sysUser.getId(), sysUser.getUsername());
        //7.返回token字符串
        Map<String,Object> map = new HashMap<>();
        map.put("token",token);
        return Result.ok(map);
    }
 }