Swagger简介

为什么使用Swagger

  这个问题就牵涉到技术的更新迭代了,在之前的后端时代,前端只需要管理静态页面,而后端需要使用模板引擎(JSP等)去得数据并加以处理,最后显示出数据。但是随着时代的发展,开发慢慢进入了前后端分离的时代,前端和后端分成了两个相对独立的团队来合作开发,这就造成了一个问题:前后端集成联调的时候,前后端人员无法做到“及时协商,尽早解决”,最终造成问题的集中爆发。

  既然已经发现问题,那么就需要使用一种解决方案来避免这个问题的干扰。做过一个完整项目的小伙伴应该都有所了解,前后端之间的协作基本上都在api接口和数据传输上,那么如果api接口能够统一、数据的格式能够一致,那么问题也就迎刃而解了。

  于是Swagger应运而生,Swagger可以根据在代码中使用自定义的注解来生成接口文档,这样做的好处是在开发接口时可以通过swagger将接口文档定义好,方便前后端团队之间的协作,同时也方便以后的维护。

Swagger的配置

Spring boot集成Swagger

新建一个spring boot项目

导入两个依赖

<!--Swagger(开始)-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
<!--Swagger(结束)-->

配置Swagger

@Configuration
@EnableSwagger2     // 开启Swagger2
public class SwaggerConfig {
}

  如果只是使用配置类开启Swagger的话,它的底层会有一些DEFAULT(默认)的值,开启之后就可以使用网址http://localhost:8080/swagger-ui.html来访问这个Swagger的文档界面。

  

当然,既然有默认的配置,我们就可以实现定制化的配置覆盖,依然是在这个配置类中进行修改

@Configuration
@EnableSwagger2     // 开启Swagger2
public class SwaggerConfig {
    /**
     *用于定制化配置Docket的bean实例
     */
    @Bean
    public Docket Docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(ApiInfo());
    }
    /**
     * 定制化信息的主要设置处
     */
    private ApiInfo ApiInfo() {
        // 作者的个人信息
        Contact contact = new Contact("作者的姓名", "作者的个人社交主页", "作者的邮箱");
        return new ApiInfo(
                "标题:Swagger的测试接口文档",
                "简介:这是一段简介,关于接口文档的简介",
                "版本号:1.0",
                "网页:这是一个网页链接",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList<>()
        );
    }
}

  修改之后的页面信息就会有一些不一样,restart项目之后重新访问ui界面

配置Swagger可扫描的接口

  这一部分的工作也是在SwaggerConfig配置类中实现,主要就是配置哪些api接口会被Swagger生成接口文档,生成文档的api就会在swagger的ui界面上显示。通过以下.apis和.paths的配置,达到的效果就是之后在com.xiaochen.swagger.controller包下的且映射路径为/hello的才会生成对应的接口文档

 @Bean
public Docket Docket() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            /**
             * apis就是配置哪些api可以被扫描
             * 主要参数可以包括:
             *  - RequestHandlerSelectors.basePackage():指定可以扫描的包 参数是包(package)名
             *  - RequestHandlerSelectors.any():扫描所有
             *  - RequestHandlerSelectors.none():都不扫描
             *  - RequestHandlerSelectors.withClassAnnotation():扫描类上注解  参数是注解类的反射对象,eg:@RestController.class
             *  - RequestHandlerSelectors.withMethodAnnotation()扫描方法上注解  参数是注解类的反射对象,eg:@RequestMapping.class
             */
            .apis(RequestHandlerSelectors.basePackage("com.xiaochen.swagger.controller"))
            /**
             * paths就是配置哪些映射路径下的api可以被扫描
             * 主要参数可以包括:
             *  - PathSelectors.ant():指定映射路径 主要就是斜杠 单词或者通配符
             *  - PathSelectors.any():扫描所有
             *  - PathSelectors.none():都不扫描
             *  - PathSelectors.regex():扫描符合正则的所有路径
             */
            .paths(PathSelectors.ant("/hello"))
            .build()
            .apiInfo(ApiInfo());
}

控制Swagger的开关

  使用.enable可以控制Swagger的开关,如果关闭了Swagger的话就会导致ui界面无法打开,也就无法查看接口文档

  

那么该如何实现只在开发和测试阶段开启Swagger呢?首先应该先预设一下想要开启的项目环境,通过Environment 对象来监听项目的环境与预设的是否一致,最后使用.enable控制Swagger的开关

@Bean
public Docket Docket(Environment environment) {
    // 预设的项目环境(可设置多个)
    Profiles profiles = Profiles.of("dev", "test");
    // 监听项目的环境与预设的是否一致
    boolean flag = environment.acceptsProfiles(profiles);
    return new Docket(DocumentationType.SWAGGER_2)
            .enable(flag);
}

设置Swagger的分组

  在没有设置Swagger的分组之前,有一个默认的default分组,分组个数的多少就取决于SwaggerConfig 配置类中有多少个Docket 实例,值得注意的是:不能出现同名的分组,即使是未命名的分组(也就是default)也不能重复出现,否则就会报java.lang.IllegalStateException异常

Swagger的各种注释

controller层使用到的注解

  • @ApiOperation(“注释”):加在方法上,注释这个方法
  • @ApiParam(“注释”):加在参数前,注释这个参数

entity层使用到的注解

  • @ApiModel(“注释”):加在实体类上,注释整个实体类
  • @ApiModelProperty(“注释”):加在实体类字段上,注释这个字段

  model里面是否有这个实体类,并不是取决于是否使用了哪个注解,而是方法的返回值是否包含这个实体类对象,也就是看有没有一个方法return了这个对象。

使用Swagger接口测试

这里的使用和postman几乎一样,可以借鉴学习

到此这篇关于Java Swagger使用教程的文章就介绍到这了,更多相关Java Swagger内容请搜索Devmax以前的文章或继续浏览下面的相关文章希望大家以后多多支持Devmax!

Java Swagger使用教程的更多相关文章

  1. Java利用POI实现导入导出Excel表格

    这篇文章主要为大家详细介绍了Java利用POI实现导入导出Excel表格,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

  2. Java 阻塞队列BlockingQueue详解

    本文详细介绍了BlockingQueue家庭中的所有成员,包括他们各自的功能以及常见使用场景,通过实例代码介绍了Java 阻塞队列BlockingQueue的相关知识,需要的朋友可以参考下

  3. Java Bean 作用域及它的几种类型介绍

    这篇文章主要介绍了Java Bean作用域及它的几种类型介绍,Spring框架作为一个管理Bean的IoC容器,那么Bean自然是Spring中的重要资源了,那Bean的作用域又是什么,接下来我们一起进入文章详细学习吧

  4. Java实现世界上最快的排序算法Timsort的示例代码

    Timsort 是一个混合、稳定的排序算法,简单来说就是归并排序和二分插入排序算法的混合体,号称世界上最好的排序算法。本文将详解Timsort算法是定义与实现,需要的可以参考一下

  5. Java日期工具类的封装详解

    在日常的开发中,我们难免会对日期格式化,对日期进行计算,对日期进行校验,为了避免重复写这些琐碎的逻辑,我这里封装了一个日期工具类,方便以后使用,直接复制代码到项目中即可使用,需要的可以参考一下

  6. Java设计模式之模板方法模式Template Method Pattern详解

    在我们实际开发中,如果一个方法极其复杂时,如果我们将所有的逻辑写在一个方法中,那维护起来就很困难,要替换某些步骤时都要重新写,这样代码的扩展性就很差,当遇到这种情况就要考虑今天的主角——模板方法模式

  7. Java 中 Class Path 和 Package的使用详解

    这篇文章主要介绍了Java 中 Class Path和Package的使用详解,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的朋友可以参考一下

  8. java SpringBoot 分布式事务的解决方案(JTA+Atomic+多数据源)

    这篇文章主要介绍了java SpringBoot 分布式事务的解决方案(JTA+Atomic+多数据源),文章围绕主题展开详细的内容介绍,具有一定的参考价值,感兴趣的小伙伴可以参考一下

  9. Java一维数组和二维数组元素默认初始化值的判断方式

    这篇文章主要介绍了Java一维数组和二维数组元素默认初始化值的判断方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

  10. java实现emqx设备上下线监听详解

    这篇文章主要为大家介绍了java实现emqx设备上下线监听详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

随机推荐

  1. 基于EJB技术的商务预订系统的开发

    用EJB结构开发的应用程序是可伸缩的、事务型的、多用户安全的。总的来说,EJB是一个组件事务监控的标准服务器端的组件模型。基于EJB技术的系统结构模型EJB结构是一个服务端组件结构,是一个层次性结构,其结构模型如图1所示。图2:商务预订系统的构架EntityBean是为了现实世界的对象建造的模型,这些对象通常是数据库的一些持久记录。

  2. Java利用POI实现导入导出Excel表格

    这篇文章主要为大家详细介绍了Java利用POI实现导入导出Excel表格,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

  3. Mybatis分页插件PageHelper手写实现示例

    这篇文章主要为大家介绍了Mybatis分页插件PageHelper手写实现示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

  4. (jsp/html)网页上嵌入播放器(常用播放器代码整理)

    网页上嵌入播放器,只要在HTML上添加以上代码就OK了,下面整理了一些常用的播放器代码,总有一款适合你,感兴趣的朋友可以参考下哈,希望对你有所帮助

  5. Java 阻塞队列BlockingQueue详解

    本文详细介绍了BlockingQueue家庭中的所有成员,包括他们各自的功能以及常见使用场景,通过实例代码介绍了Java 阻塞队列BlockingQueue的相关知识,需要的朋友可以参考下

  6. Java异常Exception详细讲解

    异常就是不正常,比如当我们身体出现了异常我们会根据身体情况选择喝开水、吃药、看病、等 异常处理方法。 java异常处理机制是我们java语言使用异常处理机制为程序提供了错误处理的能力,程序出现的错误,程序可以安全的退出,以保证程序正常的运行等

  7. Java Bean 作用域及它的几种类型介绍

    这篇文章主要介绍了Java Bean作用域及它的几种类型介绍,Spring框架作为一个管理Bean的IoC容器,那么Bean自然是Spring中的重要资源了,那Bean的作用域又是什么,接下来我们一起进入文章详细学习吧

  8. 面试突击之跨域问题的解决方案详解

    跨域问题本质是浏览器的一种保护机制,它的初衷是为了保证用户的安全,防止恶意网站窃取数据。那怎么解决这个问题呢?接下来我们一起来看

  9. Mybatis-Plus接口BaseMapper与Services使用详解

    这篇文章主要为大家介绍了Mybatis-Plus接口BaseMapper与Services使用详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

  10. mybatis-plus雪花算法增强idworker的实现

    今天聊聊在mybatis-plus中引入分布式ID生成框架idworker,进一步增强实现生成分布式唯一ID,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

返回
顶部