Swagger使用详解

已于 2023-11-30 19:11:48 修改
阅读量2.5k 收藏 11
点赞数 4
分类专栏： KekeBlog 文章标签： java
于 2023-10-08 21:22:12 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_63732435/article/details/133689227
版权

一、简介

前言

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步

Why Swagger？

当下很多公司都采取前后端分离的开发模式，前端和后端的工作由不同的工程师完成，在这种开发模式下，维持一份及时更新且完整的 Rest API 文档将会极大的提高我们的工作效率。传统意义上的文档都是后端开发人员手动编写的，这种方式很难保证文档的及时性，这种文档久而久之也就会失去其参考意义，反而还会加大我们的沟通成本。而 swagger 给我们提供了一个全新的维护 API 文档的方式

作为后端开放人员，最烦的事就是自己写接口文档和别人没有写接口文档，不管是前端还是后端开发，多多少少都会被接口文档所折磨，前端会抱怨后端没有及时更新接口文档，而后端又会觉得编写接口文档太过麻烦。Swagger 可以较好的接口接口文档的交互问题，以一套标准的规范定义接口以及相关的信息，就能做到生成各种格式的接口文档，生成多种语言和客户端和服务端的代码，以及在线接口调试页面等等。只需要更新 Swagger 描述文件，就能自动生成接口文档，做到前端、后端联调接口文档的及时性和便利性

作用
1.支持 API 自动生成同步的在线文档：使用 Swagger 后可以直接通过代码生成文档，不再需要自己手动编写接口文档了，对程序员来说非常方便

2.提供 Web 页面在线测试 API：Swagger 生成的文档支持在线测试。参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口

二、SwaggerTest项目搭建

1. pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.swagger</groupId>
    <artifactId>SwaggerTest</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <!--        springboot 启动依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <version>2.2.6.RELEASE</version>
        </dependency>
        <!--     springboot web 依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>2.2.6.RELEASE</version>
        </dependency>
        <!--lombok依赖-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.24</version>
        </dependency>

        <!-- swagger -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-spring-web</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
    </dependencies>

</project>

2. entity类

package com.swagger.entity;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
     private Long id;
     private String name;
     private int age;
}

3. controller层

package com.swagger.controller;

import com.swagger.entity.User;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

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

     @GetMapping("/getByName")
     public String getByName(){
          return "访问getByName成功";
     }
     
     @PostMapping("/login")
     public String login(@RequestBody User user){
          return "登录成功";
     }
}

三、基本使用

1. 导入相关依赖

        <!-- swagger -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-spring-web</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

2. 编写配置文件

@Configuration // 配置类
@EnableSwagger2 // 开启 swagger2 的自动配置
public class SwaggerConfig {
}

这个时候 Swagger 已经算是整合到项目之中了，可以启动下服务，输入：http://localhost:8080/swagger-ui.html# 即可查看Swagger文档，可以看到如下信息

  • 组
  • 基本信息
  • 接口信息
  • 实体类信息

2.1 配置基本信息

Swagger 在自己的实例Docket中可以设置自定义基本信息于ApiInfo对象中，下图为Swagger默认的基本信息

ApiInfo中默认的基本信息

  • title:Api Documentation
  • description:Api Documentation
  • version:1.0
  • termsOfServiceUrl:urn:tos
  • contact:无
  • license：Apache 2.0
  • licenseUrl:http://www.apache.org/licenses/LICENSE-2.0

这些信息都不是我们需求的，我们可以在Swagger配置文件中去配置属于我们自己项目的接口文档信息，代码如下

package com.swagger.config;

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

@Configuration // 配置类
@EnableSwagger2 // 开启 swagger2 的自动配置
public class SwaggerConfig {
     @Bean
     public Docket docket() {
          // 创建一个 swagger 的 bean 实例
          return new Docket(DocumentationType.SWAGGER_2)
                  // 配置基本信息
                  .apiInfo(apiInfo());
     }

     // 基本信息设置
     private ApiInfo apiInfo() {
          Contact contact = new Contact(
                  "Keke", // 作者姓名
                  "https://blog.csdn.net/m0_63732435?spm=1011.2124.3001.5343", // 作者网址
                  "1781125992@qq.com"); // 作者邮箱
          return new ApiInfoBuilder()
                  .title("SwaggerTest-接口文档") // 标题
                  .description("这是关于Swagger学习测试的接口文档") // 描述
                  .termsOfServiceUrl("https://www.baidu.com") // 跳转连接
                  .version("1.0") // 版本
                  .license("Swagger-的使用(详细教程)")
                  .licenseUrl("https://blog.csdn.net/m0_63732435/article/details/133689227?spm=1001.2014.3001.5501")
                  .contact(contact)
                  .build();
     }

}

重新启动服务，效果如下

2.2 配置接口信息

默认情况下，Swagger是会展示所有的接口信息的，包括最基础的basic-error相关接口

有时候我们希望不要展示 basic-error-controller 相关的接口，或者有其他需求，可以看以下代码和注释理解运用

@Bean
     public Docket docket() {
          // 创建一个 swagger 的 bean 实例
          return new Docket(DocumentationType.SWAGGER_2)
                  //配置基本信息
                  .apiInfo(apiInfo())
                  // 配置接口信息
                  .select() // 设置扫描接口
                  // 配置如何扫描接口
                  .apis(RequestHandlerSelectors
                                  //.any() // 扫描全部的接口，默认
                                  //.none() // 全部不扫描
                                  .basePackage("com.swagger.controller") // 扫描指定包下的接口，最为常用
                          //.withClassAnnotation(RestController.class) // 扫描带有指定注解的类下所有接口
                          //.withMethodAnnotation(PostMapping.class) // 扫描带有只当注解的方法接口

                  )
                  .paths(PathSelectors
                                  .any() // 满足条件的路径，该断言总为true
                          //.none() // 不满足条件的路径，该断言总为false（可用于生成环境屏蔽 swagger）
                          //.ant("/user/**") // 满足字符串表达式路径
                          //.regex("") // 符合正则的路径
                  )
                  .build();
     }

可以看到，basic-error相关接口我们已经去除了

2.3 配置分组信息

Swagger默认只有一个分组，名为default，如果不设置，所有的接口都会在这个分组下。在多模块项目下，我们通常会需要建立多个分组来分类管理这些接口，来防止接口混杂在一起

2.3.1 分组名修改
 @Bean
     public Docket docket() {
          // 创建一个 swagger 的 bean 实例
          return new Docket(DocumentationType.SWAGGER_2)
                  //设置分组名
                  .groupName("admin")
     }

可以看到分组名修改为admin

2.3.2 设置多个分组

实际上创建几个Docket对象，就有几个分组，代码如下

package com.swagger.config;

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;

@Configuration // 配置类
@EnableSwagger2 // 开启 swagger2 的自动配置
public class SwaggerConfig {
     @Bean
     public Docket docket() {
          // 创建一个 swagger 的 bean 实例
          return new Docket(DocumentationType.SWAGGER_2)
                  //设置分组名
                  .groupName("admin")
                  //配置基本信息
                  .apiInfo(apiInfo())
                  // 配置接口信息
                  .select() // 设置扫描接口
                  // 配置如何扫描接口
                  .apis(RequestHandlerSelectors
                                  //.any() // 扫描全部的接口，默认
                                  //.none() // 全部不扫描
                                  .basePackage("com.swagger.controller") // 扫描指定包下的接口，最为常用
                          //.withClassAnnotation(RestController.class) // 扫描带有指定注解的类下所有接口
                          //.withMethodAnnotation(PostMapping.class) // 扫描带有只当注解的方法接口

                  )
                  .paths(PathSelectors
                                  .any() // 满足条件的路径，该断言总为true
                          //.none() // 不满足条件的路径，该断言总为false（可用于生成环境屏蔽 swagger）
                          //.ant("/user/**") // 满足字符串表达式路径
                          //.regex("") // 符合正则的路径
                  )
                  .build();
     }

     @Bean
     public Docket docket1() {
          // 创建一个 swagger 的 bean 实例
          return new Docket(DocumentationType.SWAGGER_2)
                  //设置分组名
                  .groupName("blog")
                  //配置基本信息
                  .apiInfo(apiInfo())
                  // 配置接口信息
                  .select() // 设置扫描接口
                  // 配置如何扫描接口
                  .apis(RequestHandlerSelectors
                                  //.any() // 扫描全部的接口，默认
                                  //.none() // 全部不扫描
                                  .basePackage("com.swagger.controller") // 扫描指定包下的接口，最为常用
                          //.withClassAnnotation(RestController.class) // 扫描带有指定注解的类下所有接口
                          //.withMethodAnnotation(PostMapping.class) // 扫描带有只当注解的方法接口

                  )
                  .paths(PathSelectors
                                  .any() // 满足条件的路径，该断言总为true
                          //.none() // 不满足条件的路径，该断言总为false（可用于生成环境屏蔽 swagger）
                          //.ant("/user/**") // 满足字符串表达式路径
                          //.regex("") // 符合正则的路径
                  )
                  .build();
     }

     // 基本信息设置
     private ApiInfo apiInfo() {
          Contact contact = new Contact(
                  "Keke", // 作者姓名
                  "https://blog.csdn.net/m0_63732435?spm=1011.2124.3001.5343", // 作者网址
                  "1781125992@qq.com"); // 作者邮箱
          return new ApiInfoBuilder()
                  .title("SwaggerTest-接口文档") // 标题
                  .description("这是关于Swagger学习测试的接口文档") // 描述
                  .termsOfServiceUrl("https://www.baidu.com") // 跳转连接
                  .version("1.0") // 版本
                  .license("Swagger-的使用(详细教程)")
                  .licenseUrl("https://blog.csdn.net/m0_63732435/article/details/133689227?spm=1001.2014.3001.5501")
                  .contact(contact)
                  .build();
     }

}

可以看到blog模块分组的接口文档也在UI界面中展示出来

四、常用注解使用

1. @ApiModel

该注解是作用在类上的，用来描述类的一些基本信息的

相关属性：

  • value：提供类的一个备用名，如果不设置，默认情况下将使用 class 类的名称
  • description：对于类，提供一个详细的描述信息
  • parent：这个属性用于描述的是类的一些父类信息
  • discriminator：这个属性解释起来比较麻烦，因为这个类主要体现在断言当中
  • subTypes：可以通过这个属性，指定我们想要使用的子类

2.@ApiModelProperty

添加和操作属性模块的数据

package com.swagger.entity;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
@ApiModel(value = "user实体类")
public class User {
     @ApiModelProperty(value = "id主键")
     private Long id;
     @ApiModelProperty(value = "用户姓名")
     private String name;
     @ApiModelProperty(value = "用户年龄")
     private int age;
}

可以看到Model展示出来一些描述信息

3.@ApiOperation

该注解用来对某个方法/接口进行描述

 @GetMapping("/getByName")
     @ApiOperation(value = "根据姓名查询用户")
     public String getByName(){
          return "访问getByName成功";
     }

可以看到接口文档这里多了 根据姓名查询用户 的描述

4. @ApiParam

该注解使用在方法上或者参数上，字段说明，表示对参数的添加元数据（说明或者是否必填等）

相关属性：

  • name：参数名
  • value：参数说明
  • required：是否必填
 @GetMapping("/getByName/{id}")
     @ApiOperation(value = "根据id查询用户")
     public String getById(@ApiParam(value = "用户id",required = true) @PathVariable Long id){
          return "访问getById成功";
     }

可以看到，添加@ApiParam注解后，接口文档多了对参数的相应描述说明

五、Swagger接口调用

swagger 除了让前后端交互变得方便，在swagger中也可以发起请求测试接口，只需要填写好请求所需要的参数信息即可

点击Excute就可以看到接口响应的结果了

六、添加请求头

在登录注册类似涉及安全验证的业务，例如SpringSecurity框架中我们的接口是需要获取请求头信息的，这样的话就还需要在 swagger 配置中添加请求头的配置。

    @Bean
    public Docket docket() {
        // 设置请求头
        List<Parameter> parameters = new ArrayList<>();
        parameters.add(new ParameterBuilder()
                .name("token") // 字段名
                .description("token") // 描述
                .modelRef(new ModelRef("string")) // 数据类型
                .parameterType("header") // 参数类型
                .defaultValue("default value") // 默认值：可自己设置
                .hidden(true) // 是否隐藏
                .required(false) // 是否必须
                .build());

        // 创建一个 swagger 的 bean 实例
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("mike") // 修改组名为 "mike"
                // 配置接口信息
                .select() // 设置扫描接口
                // 配置如何扫描接口
                .apis(RequestHandlerSelectors
                        .basePackage("com.duojiala.mikeboot.controller") // 扫描指定包下的接口，最为常用
                )
                .paths(PathSelectors
                        .any() // 满足条件的路径，该断言总为true
                )
                .build()

                // 添加请求头参数
                .globalOperationParameters(parameters);
    }

接口

    @GetMapping(value = "/getToken")
    @ApiOperation(value = "获取请求头中的token信息")
    public void getToken(
            @RequestHeader(value = "token",required = true) String token
    ) {
        // 直接获取 token 信息
        System.out.println("token = " + token);

        // 通过代码获取
        ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        if (servletRequestAttributes != null) {
            HttpServletRequest request = servletRequestAttributes.getRequest();
            String header = request.getHeader("token");
            System.err.println("header = " + header);
        }
    }

这样重启服务，接口就可以设置请求头了

执行后，后端控制台可以打印http请求带来的token的信息

Bugman.
关注
  • 4
    点赞
  • 踩
  • 11
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
swagger的使用pom文件旧版与新版的pom文件,
07-23
swagger的使用pom文件旧版与新版的pom文件,省去自己去找对应版本的依赖文件,基本配置就是这样!
Spring Boot整合swagger使用教程详解
08-18
主要介绍了Spring Boot整合swagger使用教程,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
springboot 整合 swagger + knife4j
haiyabtx
03-03 123
pom.xml的日志依赖 <!-- Swagger API文档--> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-ui</artifactId> <version>${knife4j-spring-ui.version}</version> </dependency&gt
Swagger介绍和应用
API
10-29 1586
1、 什么是Swagger Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger让部署管理和使用功能强大的API变得非常简单。 Swagger采用Open API规范，Open API规范这类API定义语言能够帮助你更简单、快速的表述API，尤其是在API的设计阶段作用特别突出。一旦编写完成，API文档可以作为：
Java实战开发之swagger配置及访问
weixin_73922932的博客
03-21 575
Swagger 是一个流行的开源框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。它可以让开发者和用户更方便地理解和使用 API。Swagger 通过定义 RESTful API 的规范（使用 YAML 或 JSON 格式）来实现这些功能。这些规范称为 OpenAPI 规范（之前称为 Swagger 规范）。Swagger 的主要特点包括：自动生成 API 文档：通过分析代码中的注解，Swagger 自动生成清晰、易读的 API 文档，包括 API 的路径、参数、响应等详细信息。
学生成绩管理系统（增删改查）
qq_43182421的博客
05-18 2450
//成绩管理系统v1.0 #include <stdio.h> #include <stdlib.h> #include <string.h> #define N 30 #define M 6 typedef struct student { long studentID; char studentName[10]; int score[...
Swagger强大，好用，易上手的API文档工具
yuchenai的博客
01-04 1428
Swagger强大的API文档工具 1.Swagger是什么？ Swagger 是一款RESTFUL接口的、基于YAML、JSON语言的文档在线自动生成、代码自动生成的工具。Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTfu风格的web服务。 简单点来讲就是，swagger是一款可以根据restful风格生成的接口开发文档，并且支持做测试的一款中间软件。官网地址 htt...
Swagger使用
qq_43456605的博客
05-09 1617
文章目录一. 概述1. 概念2. swagger优点3. swagger缺点二. SpringBoot集成Swagger1. 整合过程三. Swagger常用的注解说明1. @Api 注解2. @ApiOperation注解3. @ApiModel注解4. @ApiModelProperty注解5. @ApiParam注解 一. 概述 1. 概念 swagger是什么？ Swagger是一种用于REST API的开源框架，它允许开发人员设计、构建、文档化和测试API。 Swagger提供了一套工具，帮助
Swagger——快速使用swagger
热门推荐
YR_112233的博客
01-21 7万+
swagger使用教程，springboot整合使用swagger
swagger介绍及使用
不要用过去的错误约束现在的自己。
06-23 8808
Swagger-概述 Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。 Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger让部署管理和使用功能强大的API从未如此简单。 本篇将使用SpringBoot进行搭建Swagger 1. maven导入Swagger包 <de
Swagger介绍及基本使用
qq_51106567的博客
07-06 3906
Swagger基本使用，SpringBoot整合Swagger，版本冲突解决
前言技术：swagger
m0_60413225的博客
03-11 368
1. 前后端分离的特点 前后端分离是的前端与后端之间的职责更加明确 后台： 负责业务处理 前端： 负责显示逻辑 在这种情况下，前端和后端可以分别交付给专业的开发人员去做，所以是必须要定义前后端直接的对接 接口，否则各自为是则项目无法集成，这时就需要一个文档来定义统一的接口。 2. 在没有swagger之前 在没有swagger之间，我们可以使用word，excel等功能来书写接口定义文档，但又有一个弊端，即： 在接口发送改变时需要及时的同步接口文档，否则实际的接口与接口文档不相
详解如何在SpringBoot里使用SwaggerUI
08-28
本篇文章主要介绍了详解如何在SpringBoot里使用SwaggerUI，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
django-rest-framework 自定义swagger过程详解
09-19
主要介绍了django-rest-framework 自定义swagger过程详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
.Net Core2.1 WebAPI新增Swagger插件详解
01-01
Swagger是一个WebAPI在线注解、调试插件，过去我们主要通过手工撰写WebAPI接口的交互文档供前端开发人员或外部开发者， 官网地址：https://swagger.io/。 但是在实际工作中，往往咋们的文档工作通常落后于实际的环境...
Day25-Java基础之常用类1
m0_46053885的博客
04-27 1165
同时我们发现Math类中的方法都是静态的，因此在使用的时候我们可以直接通过类名去调用。对于计算机而言，其实是没有数据类型的概念的，都是0101010101，数据类型是编程语言自己规定的，所以在实际存储的时候，先把具体的数字变成二进制，每32个bit为一组，存储在数组中。比较内存地址值一般情况下是没有意义的，我们希望比较的是对象的属性，如果两个对象的属性相同，我们认为就是同一个对象；如果我们的数据是一个浮点类型的数据，有的时候计算机并不会将这个数据完全转换成一个二进制数据，而是将这个将其转换成一个无限的。
链表刷题集
最新发布
yajunjiao的专栏
04-30 813
本文主要列举了一些刷的题，不多，有那么几道，也建议各位去建立自己的刷题集。积少成多。
d15(136-148)-勇敢开始Java，咖啡拯救人生
m0_73459387的博客
04-28 1353
对象哈希值的特点：同一个对象调用hashCode()返回的哈希值相同；HashMap的键依赖hashCode方法和equals方法保证键的唯一，存储自定义类型的对象时，重写这两个方法。实际上，Set系列集合的底层就是基于Map实现的，只是Set集合中的元素要键数据，不要值数据。当12个位置都占满时就会扩容，大约扩容为原来的二倍，再把原数组数据转移到新数组。使用迭代器遍历集合时，又同时在删除集合中的数据，程序就会出现并发修改异常的错误。基于哈希表实现，每个键值对额外多了一个双链表的机制，记录元素顺序（保证。
Java解决最长公共前缀
无人罪的博客
04-28 654
编写一个函数来查找字符串数组中的最长公共前缀。如果不存在公共前缀，返回空字符串""。
spring boot整合swagger使用教程详解
09-07
Spring Boot是一个开源的Java开发框架，而Swagger是一个用于构建、发布、文档化和管理API的工具。下面详细介绍如何在Spring Boot中整合Swagger。 首先，你需要在pom.xml文件中添加Swagger的依赖项。在<dependencies>标签中添加以下代码： ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.10.5</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.10.5</version> </dependency> ``` 然后，你需要在Spring Boot的配置类中添加相关的注解和配置。创建一个SwaggerConfig.java文件，添加以下代码： ```java @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("your.package.name")) .paths(PathSelectors.any()) .build(); } @Bean public UiConfiguration uiConfig() { return new UiConfiguration(null, "list", "alpha", "schema", UiConfiguration.Constants.DEFAULT_SUBMIT_METHODS, false, true, 60000L); } } ``` 在上面的代码中，你需要将"your.package.name"替换为你的应用程序的包名。这将扫描该包下的所有控制器，生成API文档。 接下来，你可以启动你的Spring Boot应用程序，并访问"http://localhost:8080/swagger-ui.html"来查看生成的API文档。你将看到所有的控制器和它们的方法以及相关的参数和注释。 如果你想修改API的文档信息，你可以使用Swagger中的注解来添加说明和标注。例如，你可以在控制器的方法上添加@ApiOperation注解来描述该方法的作用。 综上所述，将Swagger整合到Spring Boot中是很简单的。你只需要添加依赖项，配置SwaggerConfig类，然后访问Swagger UI来查看生成的API文档。同时，你可以使用Swagger注解来进一步完善API文档。希望这个教程可以帮助你理解如何在Spring Boot中使用Swagger。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值