18. Spring Boot 配置swagger文档管理

swagger是一种强大的REST接口管理系统,通过简单的配置,即可以将系统提供的REST接口以丰富的可视化形式展示给用户使用。

1. 添加依赖

要在Spring Boot中配置这个功能,首先需要增加如下其依赖。依赖分为两个部分。

<!--添加swagger依赖-->
      <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.2.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.2.2</version>
        </dependency>

2. 使能swagger的配置类

新增一个Swagger 的配置类,使用@Configuration注解和@EnableSwagger2注解该类,即可以实现一个最小化的无侵入Swagger配置。此时,打开http://localhost:8080/上下文/swagger-ui.html就能够进行访问。

当然,由于是最小化的配置,不可避免的这个文档不够人性化。包含了大量的系统内部REST服务等,也缺乏友好的交互页面。

为了能简单优化一下这个页面,我们对这个配置类进行简单的配置。

@Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("org.liyubo.lianlizhicore.controller"))  // 扫描指定的地方,不要引入一堆系统服务
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2构建 RESTful APIs")
                .description("对系统功能的简单描述")
                .termsOfServiceUrl("#")
                .contact("作者信息")
                .version("1.0")
                .build();
    }

另外,为了让每个服务能够友好的显示其功能。可以再在RSET的响应上,通过@ApiOperation(value="系统用户信息更新接口", notes="")注解进行更为详细的介绍。

3. 最终形成的一个基本效果

最终效果
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,970评论 6 342
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,981评论 19 139
  • 只希望 并且固执的认为 无论以后的人生是辉是腐 是清高还是低头 只求无悔。 一直以来,矛盾的事情 矛盾的自己 还有...
    你多真多深刻阅读 341评论 1 2
  • 我有个弟弟叫元元,他还不到五岁呢,弯弯的眉毛下面有一双囧囧有神的大眼睛,尤其是他那对儿酒窝更让人觉得可爱极了!他很...
    小学生贾梓晨阅读 383评论 0 2
  • 思来想去,第一次写文章也不知道如何下手。那就从我的梦想说起吧,那就是钢铁侠。每次重复看心情都是激动,激动得连夜搜I...
    东辉在线阅读 741评论 0 1