配置 Swagger API 基础信息

本文将介绍怎样简单配置我们 Swagger 文档的项目信息、版本信息、联系人等。

我们先看看效果图:

配置 Swagger API 基础信息

上面效果图中,配置了项目名称、版本信息、项目描述信息、联系人等基础信息。

在 Spring Boot 项目中,可以通过在 @Configuration 配置类中配置 Docket Bean。配置如下:

@Bean
public Docket buildDocket(){
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(buildApiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("指定Controller的包名称"))
            .paths(PathSelectors.any())
            .build();
}

private ApiInfo buildApiInfo(){
    return new ApiInfoBuilder()
            .title("项目名称")
            .description("项目详细描述信息")
            .termsOfServiceUrl("(网址链接) https://www.hxstrive.com")
            .contact(new Contact("联系人",
                    "联系人个人网址",
                    "联系人邮箱"))
            .version("版本信息")
            .build();
}

后续文章将介绍 Swagger 的常用注解。

一个不注意小事情的人,永远不会成功大事业。——戴尔·卡耐基
0 不喜欢
说说我的看法 -
全部评论(
没有评论
关于
本网站属于个人的非赢利性网站,转载的文章遵循原作者的版权声明,如果原文没有版权声明,请来信告知:hxstrive@outlook.com
公众号