SpringBoot+Swagger构建REST API文档

Swagger简介

SpringBoot+Swagger构建REST API文档

Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

总体目标是使客户端和文件系统作为服务器以同样的速度来更新。

文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。

Swagger 让部署管理和使用功能强大的API从未如此简单。

说人话就是:引入这个插件后,在写接口的同时加入Swagger注解可自动生成web版接口文档,这样就不怕写文档了。

一、在pom.xml中加入Swagger2的依赖

SpringBoot+Swagger构建REST API文档

二、创建Swagger2配置类

SpringBoot+Swagger构建REST API文档

三、接口方法上添加注解

SpringBoot+Swagger构建REST API文档

我们通过@ApiOperation注解来给API增加说明、通过@ApiImplicitParams、@ApiImplicitParam注解来给参数增加说明。

  • @ApiOperation:用在方法上,说明方法的作用

  • @ApiImplicitParams:用在方法上包含一组参数说明

  • @ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面

  • name:参数名

  • dataType:参数类型

  • required:参数是否必须传

  • value:参数的意思

  • defaultValue:参数的默认值

四、启动程序,访问:http://localhost:8080/swagger-ui.html

SpringBoot+Swagger构建REST API文档

备注:由于头条粘贴代码后格式不对,如果需要源码的可以评论留下邮箱。

相关推荐