swagger下面所有用到的代码基于项目云图什么是 swagger Swagger 是一个 RESTful 接口文档的

下面所有用到的代码基于项目云图

什么是 swagger

Swagger 是一个 RESTful 接口文档的规范和工具集，它的目标是统一 RESTful 接口文档的格式和规范。在开发过程中，接口文档是非常重要的一环，它不仅方便开发者查看和理解接口的功能和参数，还能帮助前后端开发协同工作，提高开发效率。在 Spring Boot 中，我们可以通过集成 Swagger 来实现接口文档的自动生成。Swagger 通过注解来描述接口，然后根据这些注解自动生成接口文档。

# Spring Boot 整合 Swagger 教程详解

应用

我们在云图项目中集成 Springboot+Swagger

依赖

<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>

常用注解

@Api：用于描述接口的类或接口
@ApiOperation：用于描述接口的方法
@ApiParam：用于描述接口的参数
@ApiModel：用于描述数据模型
@ApiModelProperty：用于描述数据模型的属性

调用了名为apiInfo的方法，该方法返回一个ApiInfo对象，用于配置API文档的基本信息，如标题、联系信息、描述和版本等