SpringBoot集成Swagger2构建在线API文档的代码详解

 更新时间:2020年12月17日 14:16:34   作者:大圣塔.Mrliu  
这篇文章主要介绍了SpringBoot集成Swagger2构建在线API文档,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

第一部分:代码集成

pom.xml

<!--swagger2配置-->
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>2.4.0</version>
    </dependency>
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.4.0</version>
    </dependency>
    <dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>swagger-bootstrap-ui</artifactId>
      <version>1.6</version>
    </dependency>

swagger2配置类

package com.liud.demo.config;

import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
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;

/**
 * TODO
 * swagger2配置类
 * @author liud
 * @version 1.0
 */

@Configuration
@EnableSwagger2
public class Swagger2 {
  //配置swagger2核心配置
  @Bean
  public Docket createRestApi(){
    return new Docket(DocumentationType.SWAGGER_2) //指定api类型位swagger2
        .apiInfo(apiInfo())            //用于定义api文档汇总信息
        .select()
        //.apis(RequestHandlerSelectors.basePackage("com.liud.demo.controller")) //指定生成文档的controller
        //.apis(RequestHandlerSelectors.any()) //为任何接口生成API文档
        //.apis(RequestHandlerSelectors.withClassAnnotation(Api.class)) //为有@Api注解的Controller生成API文档
        .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) //为有@ApiOperation注解的方法生成API文档
        .paths(PathSelectors.any())
        .build();
  }

  //api基本信息
  private ApiInfo apiInfo(){
    return new ApiInfoBuilder()
        .title("SpringBootDemo的项目接口API") //文档标题
        .contact(new Contact("liud", //作者
            "",
            "")) //联系人
        .description("SpringBootDemo的项目接口API")//详细信息
        .version("1.0.0")//文档版本号
        .termsOfServiceUrl("")//网站地址
        .build();
  }
}

Controller

package com.liud.demo.controller;

import com.liud.demo.service.HelloService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.*;

import javax.servlet.http.HttpServletRequest;

/**
 * TODO
 *
 * @author liud
 * @version 1.0
 */
@RestController
@Api(tags = {"hello操作接口"})
public class HelloController {
  @ApiOperation(value = "根据用户名获取用户信息接口")
  @RequestMapping(value = "/getuserinfo",method = RequestMethod.POST)
  public String getUserInfo(HttpServletRequest request,
               @ApiParam(name="username",value = "用户名",required = true) String username){
    return "输入的姓名:"+username+",这个用户的信息已经存在!";
  }
}

第二部分 使用 ①原路径模式

在浏览器上输入url:
http://{ip}:{port}/swagger-ui.html#/

我的地址:http://127.0.0.1:8081/swagger-ui.html

在这里插入图片描述

②文档模式

在浏览器上输入url:
http://{ip}:{port}/doc.html

我的地址:http://127.0.0.1:8081/doc.html

在这里插入图片描述

第三部分 swagger2常用注解

常用注解:

@Api()用于类;
表示标识这个类是swagger的资源
tags–表示说明
value–也是说明,可以使用tags替代
但是tags如果有多个值,会生成多个list

在这里插入图片描述

效果:

在这里插入图片描述

@ApiOperation()用于方法;
表示一个http请求的操作
value用于方法描述
notes用于提示内容
tags可以重新分组(视情况而用)

@ApiParam()用于方法,参数,字段说明;
表示对参数的添加元数据(说明或是否必填等)
name–参数名
value–参数说明
required–是否必填

@ApiParam(name="username",value = "用户名",required = true) String username

效果:

在这里插入图片描述

  • @ApiModel()用于类
  • 表示对类进行说明,用于参数用实体类接收
  • @ApiModelProperty()用于方法,字段
  • 表示对model属性的说明或者数据操作更改
  • @ApiIgnore()用于类,方法,方法参数
  • 表示这个方法或者类被忽略
  • @ApiImplicitParam() 用于方法
  • 表示单独的请求参数
  • @ApiImplicitParams() 用于方法,包含多个@ApiImplicitParam

到此这篇关于SpringBoot集成Swagger2构建在线API文档的文章就介绍到这了,更多相关SpringBoot集成Swagger2内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • java实现文件重命名功能

    java实现文件重命名功能

    这篇文章主要介绍了java实现文件重命名功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-03-03
  • SpringBoot解决跨域请求拦截问题代码实例

    SpringBoot解决跨域请求拦截问题代码实例

    这篇文章主要介绍了SpringBoot解决跨域请求拦截代码实例,在微服务开发中,一个系统包含多个微服务,会存在跨域请求的场景。 本文讲解SpringBoot解决跨域请求拦截的问题。,需要的朋友可以参考下
    2019-06-06
  • Java web基础学习之开发环境篇(详解)

    Java web基础学习之开发环境篇(详解)

    下面小编就为大家带来一篇Java web基础学习之开发环境篇(详解)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-08-08
  • Java通过调用C/C++实现的DLL动态库——JNI的方法

    Java通过调用C/C++实现的DLL动态库——JNI的方法

    这篇文章主要介绍了Java通过调用C/C++实现的DLL动态库——JNI的方法,非常不错,具有参考借鉴价值,需要的朋友可以参考下
    2018-01-01
  • 5分钟快速创建spring boot项目的完整步骤

    5分钟快速创建spring boot项目的完整步骤

    这篇文章主要给大家介绍了关于通过5分钟快速创建spring boot项目的完整步骤,文中通过示例代码介绍的非常详细,对大家学习或者使用spring boot具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-06-06
  • Spring Boot配置接口WebMvcConfigurer的实现

    Spring Boot配置接口WebMvcConfigurer的实现

    这篇文章主要介绍了SpringBoot配置接口WebMvcConfigurer的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-11-11
  • Java集合操作之List接口及其实现方法详解

    Java集合操作之List接口及其实现方法详解

    这篇文章主要介绍了Java集合操作之List接口及其实现方法,详细分析了Java集合操作中List接口原理、功能、用法及操作注意事项,需要的朋友可以参考下
    2015-07-07
  • java实现倾斜水印铺满整张图

    java实现倾斜水印铺满整张图

    这篇文章主要为大家详细介绍了java实现倾斜水印铺满整张图的具体代码,教大家如何控制水印之间的空隙,感兴趣的小伙伴们可以参考一下
    2016-06-06
  • Java的JDBC中Statement与CallableStatement对象实例

    Java的JDBC中Statement与CallableStatement对象实例

    这篇文章主要介绍了Java的JDBC中Statement与CallableStatement对象实例,JDBC是Java编程中用于操作数据库的API,需要的朋友可以参考下
    2015-12-12
  • 详解SpringBoot开发案例之整合定时任务(Scheduled)

    详解SpringBoot开发案例之整合定时任务(Scheduled)

    本篇文章主要介绍了详解SpringBoot开发案例之整合定时任务(Scheduled),具有一定的参考价值,有兴趣的可以了解一下
    2017-07-07

最新评论