ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

Swagger2

2022-01-27 10:31:23  阅读:182  来源: 互联网

标签:return swagger2 controller api 文档 Swagger2 new


1.Swagger2的基础配置(基于SpringBoot)

@Configuration
@EnableSwagger2
public class Swagger2Config {
    // swagger2的访问路径:http://localhost:8080/swagger-ui/index.html

    /**
     * 配置 swagger2 核心配置 docket
     * @return 核心配置
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)  // 指定api类型为swagger2
                    .apiInfo(apiInfo())     // 用于定义api文档汇总信息
                    .select()
                        .apis(RequestHandlerSelectors.basePackage("com.xxx.controller"))  // 指定controller路径
                    .paths(PathSelectors.any())     // 所有的controller
                    .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                    .title("Swagger2 接口api")    // 文档页标题
                    .contact(new Contact("联系人",
                            "网址",
                            "邮箱"))     // 联系人信息
                    .description("为前端提供的api文档")  // 详细信息
                    .version("1.0.1")      // 文档版本号
                    .termsOfServiceUrl("网站地址")    // 网站地址
                    .build();
    }
}

标签:return,swagger2,controller,api,文档,Swagger2,new
来源: https://www.cnblogs.com/sidneysu/p/15848961.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有