正文

springboot整合swagger2搭建api在线文档

yueshutong  2022-04-24  231

关键词：

Swagger，中文“拽”的意思，它是一个功能强大的在线API在线文档，目前它的版本为2.x，所以称为Swagger2。Swagger2提供了在线文档的查阅和测试功能。利用Swagger2很容易构建RESTful风格的API，在SpringBoot中集成Swagger2，步骤如下。

1.引入依赖

        <!--Swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

2.配置Swagger2

@Configuration
@EnableSwagger2
public class Swagger2Config {


    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("cn.yuehsutong.swagger2.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("SpringBoot利用Swagger构建API文档")
                .description("描述内容")
                .termsOfServiceUrl("服务url")
                .version("版本")
                .build();
    }

}

3.写Swagger注解

@RestController
public class DemoController {

    @RequestMapping(value = "/users",method = RequestMethod.GET)
    @ApiOperation(value = "接口名称", notes = "接口的详细说明")
    public Object users(){
        Map<String,String> map = new HashMap<>();
        map.put("one","zhansan");
        return map;
    }
}

4.浏览Swagger-UI在线文档

默认访问路径：http://localhost:8080/swagger-ui.html

技术分享图片

5.常用Swagger注解

@Api()用于类，表示标识这个类是swagger的资源
@ApiOperation()用于方法，表示一个http请求的操作
@ApiParam()用于方法，参数，字段说明；表示对参数的添加元数据（说明或是否必填等）
@ApiModel()用于类，表示对类进行说明，用于参数用实体类接收
@ApiModelProperty()用于方法，字段，表示对model属性的说明或者数据操作更改
@ApiIgnore()用于类，方法，方法参数，表示这个方法或者类被忽略
@ApiImplicitParam() 用于方法，表示单独的请求参数
@ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam

学习资源

Swagger-Core Annotations

springboot整合swagger2

一关于SwaggerSwagger能成为最受欢迎的RESTAPIs文档生成工具之一，有以下几个原因：Swagger可以生成一个具有互动性的API控制台，开发者可以用来快速学习和尝试API。Swagger可以生成客户端SDK代码用于各种不同的平台上的实现。Swagger... 查看详情

springboot整合swagger2框架

一：什么是SwaggerSwagger是一款通过我们添加的注解来对方法进行说明，来自动生成项目的在线api接口文档的web服务。二：添加Swagger2依赖<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><ve 查看详情

软件工程应用与实践——swagger2搭建(代码片段)

...f0c;单独测试的缺点。二、搭建swagger2由于本项目后端使用SpringBoot，而swagger2可以快速整合到SpringBoot项目中。在本项目中，成功利用Springboot整合swagger2。引入依赖搭建Swagger2需要添加相关的依赖，添加了两个依赖ÿ 查看详情

springboot整合swagger2

　　手写Api文档的几个痛点：文档需要更新的时候，需要再次发送一份给前端，也就是文档更新交流不及时。接口返回结果不明确不能直接在线测试接口，通常需要使用工具，比如postman接口文档太多，不好管理　　Swagger也就是... 查看详情

springboot整合swagger2+knife4j

参考技术A前言:前面文件已经发过swagger2的整合教程SpringBoot整合swagger，本文主要是介绍knife4j。Knife4j是为JavaMVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望她能像一把匕首一样小巧,轻量,并且功... 查看详情

springboot之整合swagger2

参考技术A随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了：前端渲染、先后端分离的形态，而且前端技术和后端技术在各自的道路上越走越远。前端和后端的唯一联系，变成了API接口；API文档变成了... 查看详情

springboot2整合swagger2-plus

目录一.整合swagger21.加依赖2.写配置3.常用注解：4.演示demo5.实际效果查询新增登录二.整合swagger2-plus1.加依赖2.写配置3.实际应用4.最终效果新增登录一.整合swagger21.加依赖<dependency><groupId>io.springfox</gr... 查看详情

一分钟完成springboot项目整合swagger2实现自动生成接口文档

...但本人认为还是利大于弊的。接下来我们将Swagger2整合到springboot项目中，并用swagger-bootstrap-ui对Swagger2进行界面美化，废话不多说，我们开始。。。在pom.xml中导入在application.yml中设置swagger2是否开启的开关，关闭后接口文档被关... 查看详情

springboot之swagger2集成

一、Swagger2简单介绍　　Swagger2，它可以轻松的整合到SpringBoot中，并与SpringMVC程序配合组织出强大RESTfulAPI文档。它既可以减少我们创建文档的工作量，同时说明内容又整合入实现代码中，让维护文档和修改代码整合为一体，可以... 查看详情

springboot整合swagger2使用教程

1.引入依赖<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId>< 查看详情

[idea]springboot整合swagger2实现crud

一：创建SpringBoot,在pom.xml文件中加入jar包　　<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.8.0</version></dependenc 查看详情

springboot整合swagger来操作api

1.pom.xml<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.6.1</version> 查看详情

springboot整合swagger2自动生成restfulapi文档

1）首先编辑pom.xml添加依赖<dependency>　　<groupId>io.springfox</groupId>　　<artifactId>springfox-swagger2</artifactId>　　<version>2.9.2</version></dependency><de 查看详情

springboot整合swagger，方便后端测试

参考技术A用Swagger能够在后端写好接口后进行测试，测试过程非常方便。Swagger是一个用于生成、描述和调用RESTful接口的Web服务。通俗的来讲，Swagger就是将项目中所有（想要暴露的）接口展现在页面上，并且可以进行接口调用和... 查看详情

zuul中整合swagger2，实现对源服务api测试

前言我们知道，Swagger2整合到项目中，可以非常方便地进行接口测试，是前后端对接效率提高。现在，我们可以在Zuul中整合Swagger2，通过Zuul配置文件配置的映射路径，来生成源服务接口的测试Dashboard。github... 查看详情

zuul中整合swagger2，实现对源服务api测试

springboot集成swagger2生成api接口文档(代码片段)

SpringBoot2.3.0集成Swagger2引入Swagger2相应的依赖入门示例SpringBoot2集成Swagger2后启动报错结语背景：最近在工作中发现，已经多次发现后台开发人员提供的接口协议和实际的业务代码不统一。这些现象往往都是因为开发人员在... 查看详情

springboot之swagger2

SpringBoot利用Swagger2只需配置少量的注解信息便能方便地构建强大的API文档。1、添加maven依赖 2、创建Swagger2配置类 3、在API添加文档内容 4、访问http://localhost:8080/swagger-ui.html 查看详情