在SpringBoot中使用Swagger 文档

前言

很早之前就听说Swagger文档，但是一直没有认真学习和动手实践，在和朋友做项目的时候看到别人写的一些代码，觉得有点懵，所以这次就动手记录一下入门的简单示例，真正项目的时候应该会更复杂。

Swagger简介

swagger包括三部分: Swagger Editor(基于浏览器的编辑器)，Swagger UI(可以让我们通过浏览器来查看并操作Rest API，Swagger Codegen。

Swagger接口相关注解说明

1.@Api：可设置对控制器的描述

2. @ApiOperation：: 可设置对接口的描述

3 .@ApiIgnore: Swagger 文档不会显示拥有该注解的接口。

4 @ApiImplicitParams: 用于描述接口的非对象参数集。

5 @ApiImplicitParam: 用于描述接口的非对象参数，一般与 @ApiImplicitParams 组合使用。

6 @ApiModel:可设置接口相关实体的描述

7 @ApiModelProperty: 可设置实体属性的相关描述。

Swagger与SpringBoot实践

1 构建maven项目:可以从spring官网的Spring initializer页面生成一个空的springBoot 项目，然后添加如下依赖:

2 在项目中新建controller，model，configure包，然后再model里面创建User.class，UserController.class。

API configure 类

UserController.class

启动程序的类

2 启动程序后可看到如下界面，在浏览器中输入:http://localhost:8080/swagger-ui.html

我们也可以直接通过界面去操作接口方法。

总结

通过一个简单的例子整明白了swagger入门方法。我想在真是的项目中可能会被用得更加复杂。