博客

Swagger介绍

Spring Boot 可以集成Swagger，生成Swagger接口，Spring Boot是Java领域的神器，它是Spring项目下快速构建 项目的框架。

在Java类中添加Swagger的注解即可生成Swagger接口，常用Swagger注解如下：

@Api：修饰整个类，描述Controller的作用

@ApiOperation：描述一个类的一个方法，或者说一个接口

@ApiParam：单个参数描述

@ApiModel：用对象来接收参数

@ApiModelProperty：用对象接收参数时，描述对 象的一个字段

@ApiResponse：HTTP响应其中1个描述

@ApiResponses：HTTP响应整体描述

@ApiIgnore：使用 该注解忽略这个API

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

@ApiImplicitParam：一个请求参数

@ApiImplicitParams：多个请求参数

@ApiImplicitParam属性：

配置

@EnableSwagger2这个注解一开启，就会扫描.apis(RequestHandlerSelectors.basePackage(“com.xuecheng”))里的com.xuecheng下面的所有标记了@RestController的注解的类。根据类的所有方法生成接口文档。

访问swagger接口文档

启动cms服务工程，查看接口文档，请求：http://localhost:31001/swagger-ui.html

使用Swagger工具测试服务接口：

1）在cms服务接口中打断点

2）打开接口文档页面，输入请求参数，点击“Try it out”发起请求。