实战分布式医疗挂号系统之整合Swagger2到通用模块

 更新时间:2022年04月24日 15:44:09   作者:Hudie.  
这篇文章主要为大家介绍了实战分布式医疗挂号系统之整合Swagger2到通用模块,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

文章导读

本系列文章介绍从0开始搭建一个基于分布式的医疗挂号系统。本次四篇文章完成了医院设置微服务模块的后端接口,为了方便开发,对接口的返回结果、全局异常、全局日志进行了统一处理。 同时,为了方便进行访问测试,还整合了Swagger2工具,这些通用的模块中,除了全局日志被放在医院设置微服务模块的配置资源中,其余都统一被抽取在common模块中。具体实现可参考下面文章:

医院设置微服务 | 模块搭建

医院设置微服务 | 接口开发

通用模块 | 统一返回结果、统一异常处理、统一日志处理

项目已开源至  https://github.com/Guoqianliang/yygh_parent

在使用REST风格进行接口的开发测试时,post请求无法使用浏览器直接进行访问测试,目前流行的解决方案是使用Swagger2。Swagger2是一个API接口文档,通过Swagger2可以方便各种提交方式的接口测试。

通过Swagger2,我们可以看到接口名称、请求方法、传递参数、返回信息等。

通用模块整合swagger2步骤

本项目中,众多的微服务都需要整合Swagger2,所以我将其依赖引入在了通用的common父模块中,配置在common_util模块中。

1.引入swagger依赖

        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>

2.配置Swagger2

如下的Swagger2配置信息中分别创建了webApi分组和adminApi分组的Bean。

/**
 * Swagger2配置信息
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket webApiConfig() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                //只显示api路径下的页面
                .paths(Predicates.and(PathSelectors.regex("/api/.*")))
                .build();
    }
    @Bean
    public Docket adminApiConfig() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("adminApi")
                .apiInfo(adminApiInfo())
                .select()
                //只显示admin路径下的页面
                .paths(Predicates.and(PathSelectors.regex("/admin/.*")))
                .build();
    }
    private ApiInfo webApiInfo() {
        return new ApiInfoBuilder()
                .title("网站-API文档")
                .description("本文档描述了网站微服务接口定义")
                .version("1.0")
                .contact(new Contact("gql", "http://gql.com", "guoqianliang@foxmail.com"))
                .build();
    }
    private ApiInfo adminApiInfo() {
        return new ApiInfoBuilder()
                .title("后台管理系统-API文档")
                .description("本文档描述了后台管理系统微服务接口定义")
                .version("1.0")
                .contact(new Contact("gql", "http://gql.com", "guoqianliang@foxmail.com"))
                .build();
    }
}

3.启动类添加包扫描

Swagger2的配置类写好了,现在需要在service_host模块使用配置类。由于二者不在同一个项目中,所以需要在service_host模块的父模块的pom中引入service_util

而两者包名不同,还需要额外在启动类上添加包扫描。

引入swagger配置类

测试

项目启动后访问:http://localhost:8201/swagger-ui.html ,可以看到项目中接口的信息:

通过swagger查看后台API文档

在Controller中添加下面几个简单的Api注解,可以将swagger中的一些信息定义为中文:

通过swagger添加注解

如果需要测试接口,我们只需要点击接口下方的Try it out 按钮:

通过swagger测试方法

点击按钮后即可,看到接口的一系列返回信息:

通过swagger查看方法返回结果

swagger常用注解

注解说明
@Api修饰整个类,描述Controller的作用
@ApiOperation描述一个类的一个方法,或者说一个接口
@ApiParam单个参数描述
@ApiModel用对象来接收参数
@ApiModelProperty用对象接收参数时,描述对象的一个字段
@ApiImplicitParam一个请求参数
@ApiImplicitParams多个请求参数

以上就是实战分布式医疗挂号系统之整合Swagger2到通用模块的详细内容,更多关于分布式医疗挂号整合Swagger2模块的资料请关注脚本之家其它相关文章!

相关文章

  • Java本地缓存工具之LoadingCache的使用详解

    Java本地缓存工具之LoadingCache的使用详解

    缓存,在我们日常开发中是必不可少的一种解决性能问题的方法。简单的说,cache 就是为了提升系统性能而开辟的一块内存空间。本文将为大家介绍一个Java本地缓存的工具——LoadingCache,感兴趣的可以了解一下
    2021-12-12
  • Spring 静态变量/构造函数注入失败的解决方案

    Spring 静态变量/构造函数注入失败的解决方案

    我们经常会遇到一下问题:Spring对静态变量的注入为空、在构造函数中使用Spring容器中的Bean对象,得到的结果为空。不要担心,本文将为大家介绍如何解决这些问题,跟随小编来看看吧
    2021-11-11
  • MySQL安装与idea的连接实现

    MySQL安装与idea的连接实现

    本文主要介绍了MySQL安装与idea的连接实现,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-01-01
  • Spring实现类私有方法的几个问题(亲测通用解决方案)

    Spring实现类私有方法的几个问题(亲测通用解决方案)

    现实的业务场景中,可能需要对Spring的实现类的私有方法进行测试。本文给大家分享Spring实现类私有方法面临的几个问题及解决方案,感兴趣的朋友跟随小编一起看看吧
    2021-06-06
  • struts2 中文乱码的解决办法分享

    struts2 中文乱码的解决办法分享

    这篇文章主要介绍了struts2 中文乱码的解决办法,需要的朋友可以参考下
    2014-02-02
  • Java中List集合的深入介绍(超级推荐!)

    Java中List集合的深入介绍(超级推荐!)

    List接口是继承Collection接口,所以Collection集合中有的方法,List集合也继承过来,下面这篇文章主要给大家介绍了关于Java中List集合的相关资料,需要的朋友可以参考下
    2022-01-01
  • Java手写Redis服务端的实现

    Java手写Redis服务端的实现

    本文主要介绍了Java手写Redis服务端的实现,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-12-12
  • Java源码解析Integer方法解读

    Java源码解析Integer方法解读

    这篇文章主要介绍了Java源码解析Integer方法解读,包括toString方法、toUnsignedString方法、highestOneBit方法等,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-12-12
  • Java中字符串去重的特性介绍

    Java中字符串去重的特性介绍

    这篇文章主要介绍了Java中字符串去重的特性,是Java8中引入的一个新特性,至于是否真的用起来顺手就见仁见智了...需要的朋友可以参考下
    2015-07-07
  • SpringMVC 数据校验实例解析

    SpringMVC 数据校验实例解析

    这篇文章主要介绍了SpringMVC 数据校验实例解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-11-11

最新评论