springboot 配置使用swagger2操作

 更新时间:2020年10月01日 11:24:07   作者:smile-yan  
这篇文章主要介绍了springboot 配置使用swagger2操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧

swagger是一个功能强大的在线API文档的框架,提供了优雅的API在线文档的查阅和测试功能。

利用swagger2可以很方便的构建RESTful风格的API文档,在springboot中使用也非常方便,主要是在controller前配置添加注解就可以了,详细配置过程如下:

1. maven依赖包

使用目前最新版本为例,pom.xml添加的代码如下

  <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>2.9.2</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.9.2</version>
    </dependency>

2. 配置类的编写

配置类的编写同样非常简单,可以直接复制粘贴以下代码,但是一定要注意做适当修改,尤其是设置basePackage的路径,一定要根据实际情况修改。

新建一个config文件夹,在此文件夹中新建一个类

package cn.smileyan.swagger.config;

import org.springframework.beans.factory.annotation.Configurable;
import org.springframework.context.annotation.Bean;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@EnableSwagger2
@Configurable
public class Swagger2 {
  /**
   * 特别要注意.apis(RequestHandlerSelectors.basePackage("cn.smileyan.swagger.controller"))
   * 此中的cn.smileyan.swagger.controller一定要修改为自己controller包。
   * @return
   */
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("cn.smileyan.swagger.controller"))
        .paths(PathSelectors.any())
        .build();
  }

  private ApiInfo apiInfo() {
    return new ApiInfoBuilder().title("springboot使用swagger例子")
        .description("简单优雅的restful风格")
        .termsOfServiceUrl("https://smileyan.cn")
        .version("1.0")
        .build();
  }
}

不能忘记类前面的@EnableSwagger2 与 @Configurable配置注解。以及后面的@Bean注解。

3. @EnableSwagger2 不能忘了

除了这个位置需要添加这个注解,还有springboot的运行类(application类)也要添加这个注释,否则会出现错误。

如图所示,我的application类名为SwaggerApplication,在这个类上面添加@EnableSwagger2

package cn.smileyan.swagger;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@EnableSwagger2
public class SwaggerApplication {

  public static void main(String[] args) {
    SpringApplication.run(SwaggerApplication.class, args);
  }
}

4. 编写controller类,添加注解,注意这个controller路径与上面配置类的路径要保持一致。

package cn.smileyan.swagger.controller;

import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;
import java.util.Map;

@RestController
@RequestMapping("/user")
public class UserController {

  @ApiOperation(value = "用户测试",notes = "贵宾用户")
  @RequestMapping(value = "",method = RequestMethod.GET)
  private Map<String,String> getUser() {
    Map<String,String> map = new HashMap<>(1);
    map.put("result","success");
    return map;
  }
}

5. 运行,打开api文档http://localhost:8080/swagger-ui.html

效果如下:

可以点开user-controller,效果如下:

完成测试。很简单吧。

常用注解

@Api : 修饰整个类,用于描述Controller类

@ApiOperation:描述类的方法,或者说一个接口

@ApiParam:单个参数描述

@ApiModel:用对象来接收参数

@ApiProperty:用对象接收参数时,描述对象的一个字段

@ApiResponse:HTTP响应的一个描述

@ApiResponses:HTTP响应的整体描述

@ApiIgnore:使用该注解,表示Swagger2忽略这个API

@ApiError:发生错误返回的信息

@ApiParamImplicit:一个请求参数

@ApiParamsImplicit:多个请求参数

以上这篇springboot 配置使用swagger2操作就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • java中申请不定长度数组ArrayList的方法

    java中申请不定长度数组ArrayList的方法

    今天小编就为大家分享一篇java中申请不定长度数组ArrayList的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-07-07
  • java 打造阻塞式线程池的实例详解

    java 打造阻塞式线程池的实例详解

    这篇文章主要介绍了java 打造阻塞式线程池的实例详解的相关资料,这里提供实例帮助大家,理解这部分知识,需要的朋友可以参考下
    2017-07-07
  • 关于Java中HashCode方法的深入理解

    关于Java中HashCode方法的深入理解

    这篇文章主要给大家介绍了关于Java中HashCode方法的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用Java具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-08-08
  • 使用JAXBContext 设置xml节点属性

    使用JAXBContext 设置xml节点属性

    这篇文章主要介绍了使用JAXBContext 设置xml节点属性的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • 在Java生产环境下进行性能监控与调优的详细过程

    在Java生产环境下进行性能监控与调优的详细过程

    在Java生产环境下进行性能监控与调优是一个复杂但重要的过程,它涉及到多个方面,包括代码分析、JVM监控、线程管理、垃圾收集优化、内存管理、数据库交互等,下面我将提供一个详细的概述和示例代码,需要的朋友可以参考下
    2025-02-02
  • Java使用bcrypt实现对密码加密效果详解

    Java使用bcrypt实现对密码加密效果详解

    bcrypt是一种自带盐值(自动加盐)的加密方案。本文将通过示例为大家详细介绍这一对密码进行加密的算法,感兴趣的小伙伴可以跟随小编一起学习一下
    2022-03-03
  • spring mvc中的@PathVariable动态参数详解

    spring mvc中的@PathVariable动态参数详解

    这篇文章主要介绍了spring mvc中的@PathVariable动态参数详解,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • struts2+spring+ibatis框架整合实现增删改查

    struts2+spring+ibatis框架整合实现增删改查

    这篇文章主要为大家详细介绍了struts2+spring+ibatis框架整合实现增删改查操作,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-07-07
  • Seata集成Mybatis-Plus解决多数据源事务问题

    Seata集成Mybatis-Plus解决多数据源事务问题

    当进行业务操作时,订单发生异常 ,进行了回滚操作,因为在不同的数据库实例中,余额却扣除成功,此时发现数据不一致问题,本文给大家介绍Seata集成Mybatis-Plus解决多数据源事务问题,感兴趣的朋友一起看看吧
    2023-11-11
  • Spring Security实现HTTP认证

    Spring Security实现HTTP认证

    本文主要介绍了Spring Security实现HTTP认证,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧<BR>
    2022-06-06

最新评论