手把手教你SpringBoot快速集成Swagger的配置过程

 更新时间:2021年02月20日 14:58:51   作者:常安、  
这篇文章主要介绍了手把手教你SpringBoot快速集成Swagger的配置过程,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

导语

相信大家无论是做前端还是做后端的,都被接口接口文档所折磨过,前端抱怨接口文档和后端给的不一致,后端抱怨写接口文档很麻烦,所以Swagger就诞生了。直接配置即可自动生成接口文档,而且提供了高效的API测试
话不多说直接开干
导入SpringBoot集成Swagger所需要的依赖

 <!--web方便测试-->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- swagger2核心包 -->
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.9.2</version>
    </dependency>
    <!-- swagger-ui 可视化界面 -->
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>2.9.2</version>
    </dependency>

Swagger可视化界面可分为三个区域

在这里插入图片描述

Swagger相关配置

package com.example.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@Configuration
@EnableSwagger2 //开启Swagger的使用
public class SwaggerConfig {

  @Bean  //Swagger的使用主要是要将docket对象传入IOC容器
  public Docket docket(){
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo()) //关于文档的各种信息
        .enable(true) //使Swagger生效
        .groupName("常安祖")
        .select()//选择扫描的接口
        .apis(RequestHandlerSelectors.basePackage("com.example.controller"))//指定扫描的接口
        .build();
  }


  public ApiInfo apiInfo(){
    Contact contact = new Contact("长安","https://blog.csdn.net/weixin_45647685","719801748@qq.com");//个人的联系方式
    return new ApiInfo("长安的文档", "长安的开发文档", "1.0", "urn:tos",null, "Apache 2.0", "http://www.apache.org/licenses/LICENSE-2.0", new ArrayList());//文档的各种信息
  }
}

@ApiModel( ) //主要用来标注返回的实体类
@ApiModelProperty( ) //主要用来标注实体类中的属性
案例:

@ApiModel("用户的实体类")
public class User implements Serializable {

  @ApiModelProperty("用户的id")
  private Integer id;

  @ApiModelProperty("用户的姓名")
  private String name;

  @ApiModelProperty("用户的年纪")
  private Integer age;

  public Integer getId() {
    return id;
  }
  public User(Integer id, String name, Integer age) {
    this.id = id;
    this.name = name;
    this.age = age;
  }

  public void setId(Integer id) {
    this.id = id;
  }

  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  public Integer getAge() {
    return age;
  }

  public void setAge(Integer age) {
    this.age = age;
  }
}

@ApiModelProperty用来标注API接口
案例:

package com.yangzihao.controller;

import com.yangzihao.entity.User;
import io.swagger.annotations.ApiModelProperty;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;

@RestController
public class UserController {

  @ApiModelProperty("得到一个User")
  @GetMapping("/getUser")
  public User getUser(){
    return new User(1,"测试",18);
  }
}

进入Swagger可视化界面

在这里插入图片描述

使用Swagger进行接口测试

在这里插入图片描述

执行

在这里插入图片描述

到此这篇关于手把手教你SpringBoot快速集成Swagger的配置过程的文章就介绍到这了,更多相关SpringBoot集成Swagger内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java中实体类为什么要实现Serializable序列化的作用

    Java中实体类为什么要实现Serializable序列化的作用

    这篇文章主要介绍了Java中实体类为什么要实现Serializable序列化的作用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-11-11
  • SpringMVC配置拦截器实现登录控制的方法

    SpringMVC配置拦截器实现登录控制的方法

    这篇文章主要介绍了SpringMVC配置拦截器实现登录控制的方法,SpringMVC读取Cookie判断用户是否登录,对每一个action都要进行判断,有兴趣的可以了解一下。
    2017-03-03
  • springboot websocket集群(stomp协议)连接时候传递参数

    springboot websocket集群(stomp协议)连接时候传递参数

    这篇文章主要介绍了springboot websocket集群(stomp协议)连接时候传递参数,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-07-07
  • spring security在分布式项目下的配置方法(案例详解)

    spring security在分布式项目下的配置方法(案例详解)

    这篇文章主要介绍了spring security在分布式项目下的配置方法,本文通过一个项目案例给大家详细介绍,通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-10-10
  • springboot集成普罗米修斯(Prometheus)的方法

    springboot集成普罗米修斯(Prometheus)的方法

    这篇文章主要介绍了springboot集成普罗米修斯(Prometheus)的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-08-08
  • Java将微信和支付宝支付的个二维码合二为一的方法

    Java将微信和支付宝支付的个二维码合二为一的方法

    这篇文章主要介绍了Java将微信和支付宝支付的个二维码合二为一的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-08-08
  • log4j.properties 配置(实例讲解)

    log4j.properties 配置(实例讲解)

    下面小编就为大家带来一篇log4j.properties 配置(实例讲解)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-08-08
  • spring boot 注册拦截器过程详解

    spring boot 注册拦截器过程详解

    这篇文章主要介绍了spring boot中注册拦截器过程详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-11-11
  • 深入理解Spring注解@Async解决异步调用问题

    深入理解Spring注解@Async解决异步调用问题

    这篇文章主要介绍了深入理解Spring注解@Async解决异步调用问题,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • java模拟ATM功能(控制台连接Mysql数据库)

    java模拟ATM功能(控制台连接Mysql数据库)

    这篇文章主要介绍了java模拟ATM功能,控制台连接Mysql数据库,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-05-05

最新评论