Spring Boot Swagger2使用方法过程解析

 更新时间:2020年08月19日 15:00:06   作者:陶海军  
这篇文章主要介绍了Spring Boot Swagger2使用方法过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

1.添加Swagger2依赖

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

2配置类

@Configuration
@EnableSwagger2
public class Swagger2 {
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.bs.swaggertest.controller"))
        .paths(PathSelectors.any())
        .build();
  }
  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("微信项目接口对接文档")
        .description("测试环境接口调试")
        .contact("陶海军")
        .version("1.0")
        .build();
  }
}

3.添加文档内容

@RestController
@RequestMapping(value="/users")
public class UserController {
  @ApiOperation(value="删除用户", notes="根据url的id来指定删除对象")
  @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "String")
  @RequestMapping(value="/{id}", method=RequestMethod.DELETE)
  public String deleteUser(@PathVariable String id) {
    return "success";
  }
}

4.测试

http://localhost:8080/swagger-ui.html

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • 使用Spring Retry实现业务异常重试

    使用Spring Retry实现业务异常重试

    在系统中经常遇到业务重试的逻辑,比如三方接口调用,timeout重试三遍,异常处理重试的兜底逻辑等,本文给大家介绍一下如何使用Spring Retry优雅的实现业务异常重试,需要的朋友可以参考下
    2024-01-01
  • 使用OkHttp3以Multipart/Form-Data方式上传文件方式

    使用OkHttp3以Multipart/Form-Data方式上传文件方式

    在开发过程中,使用multipart/form-data进行图片上传是一个常见的需求,本文通过一个实际案例,讲解了如何在项目中添加OkHttp3库依赖,并使用multipart/form-data进行图片上传,首先,介绍了ContentType的概念和常见类型
    2024-10-10
  • SpringCloud学习笔记之Feign远程调用

    SpringCloud学习笔记之Feign远程调用

    Feign是一个声明式的http客户端。其作用就是帮助我们优雅的实现http请求的发送。本文将具体为大家介绍一下Feign的远程调用,感兴趣的可以了解一下
    2021-12-12
  • SpringBoot中使用Flyway进行数据库迁移的详细流程

    SpringBoot中使用Flyway进行数据库迁移的详细流程

    本文介绍了如何在Spring Boot项目中使用Flyway进行数据库迁移,Flyway通过SQL脚本管理数据库变更,支持自动执行和版本控制,避免了手动执行SQL脚本的错误和维护困难,需要的朋友可以参考下
    2025-02-02
  • java 排序算法之归并排序

    java 排序算法之归并排序

    本文主要讲解了排序算法中的归并排序,文中运用大量的图片和代码讲解的非常详细,感兴趣的朋友可以学习一下这篇文章,相信可以帮助到你
    2021-09-09
  • 为何找不到Java 7中的警告

    为何找不到Java 7中的警告

    在本篇文章和里小编给大家整理的是关于Java 7中的警告的相关知识点内容,有需要的朋友们可以参考下。
    2019-11-11
  • 深入探究Java线程的创建与构造方法

    深入探究Java线程的创建与构造方法

    这篇文章主要给大家分享的是java线程的创建以及构造方法,想了解具体方式的小伙伴可以参考下面文章内容,希望对你有所帮助
    2022-04-04
  • Java技巧分享之利用RxJava打造可观测数据RxLiveData

    Java技巧分享之利用RxJava打造可观测数据RxLiveData

    这篇文章主要来和大家分享一个Java技巧,那就是利用RxJava打造可观测数据RxLiveData,文中的示例代码讲解详细,感兴趣的小伙伴可以了解一下
    2023-06-06
  • 在springboot中使用注解将值注入参数的操作

    在springboot中使用注解将值注入参数的操作

    这篇文章主要介绍了在springboot中使用注解将值注入参数的操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-04-04
  • Java后端学习精华之TCP通信传输协议详解

    Java后端学习精华之TCP通信传输协议详解

    TCP/IP是一种面向连接的、可靠的、基于字节流的传输层通信协议,它会保证数据不丢包、不乱序。TCP全名是Transmission Control Protocol,它是位于网络OSI模型中的第四层
    2021-09-09

最新评论