栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

最新版Knife4j在SpringBoot中的使用,比Swagger更好看强大

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

最新版Knife4j在SpringBoot中的使用,比Swagger更好看强大

1、SpringBoot中引入依赖。

        
            com.github.xiaoymin
            knife4j-spring-boot-starter
            3.0.2
        

2、增加Swagger配置类。

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean(value = "1.web")
    public Docket webAPI(){
        return createDocket("1.web", "com.hello.controller");
    };

    public Docket createDocket(String groupName, String basePackage) {
        Docket docket=new Docket(documentationType.SWAGGER_2)
                .enable(true)
                .apiInfo(apiInfo())
                //将日期时间类型全部转为String类型
                .directModelSubstitute(LocalDateTime.class, String.class)
                //将日期类型全部转为String类型
                .directModelSubstitute(LocalDate.class, String.class)
                //将时间类型全部转为String类型
                .directModelSubstitute(LocalTime.class, String.class)
                //分组名称
                .groupName(groupName)
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.any())
                .build()
                .globalRequestParameters(generateRequestParameters());
        return docket;
    }

    private List generateRequestParameters(){
        RequestParameterBuilder token = new RequestParameterBuilder();
        RequestParameterBuilder language = new RequestParameterBuilder();
        List parameters = Lists.newArrayList();
        token.name("Authorization").description("token令牌").in(In.HEADER.toValue()).required(true).build();
        language.name("language").description("语言").in(In.HEADER.toValue()).required(false).build();
        parameters.add(token.build());
        parameters.add(language.build());
        return parameters;
    }


    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Hello World API")
                .description("Hello World API文档")
                .version("1.0")
                .build();
    }
}

3、在Controller中增加注解。

@RestController
@Slf4j
@RequestMapping("/love")
@Api(value = "love", tags = {"爱你一万年接口"})
public class LoveController {

	@GetMapping("/me")
    @ApiOperation(value = "爱我")
    public Result me() {
        
        return Result.ok();
    }

}
转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/424299.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号