Swagger-UI 基于REST的API管理

 

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

 

这里主要说明下swagger在java中是使用总结：

一、环境：

1、JAVA8

2、MAVEN

3、IDEA

4、SPRING BOOT

二、相关依赖：

三、配置：

 

四、相关注解：

1. @Api

用在类上，说明该类的作用

@Api(value = "UserController", description = "用户相关api")

 

2. @ApiOperation

用在方法上，说明方法的作用

@ApiOperation(value = "查找用户", notes = "查找用户", httpMethod = "GET", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)

 

3 @ApiImplicitParams

用在方法上包含一组参数说明

 

4. @ApiImplicitParam

   用在@ApiImplicitParams注解中，指定一个请求参数的各个方面

paramType：参数放在哪个地方

header–>请求参数的获取：@RequestHeader

query–>请求参数的获取：@RequestParam

path（用于restful接口）–>请求参数的获取：@PathVariable

body（不常用）

form（不常用）

name：参数名

dataType：参数类型

required：参数是否必须传

value：参数的意思

defaultValue：参数的默认值。

 

5. @ApiResponses

用于表示一组响应

6. @ApiResponse

   用在@ApiResponses中，一般用于表达一个错误的响应信息

code：数字，例如400

message：信息，例如”请求参数没填好”

response：抛出异常的类

五、和Swagger UI的集成

首先，从github swagger-ui 上下载Swagger-UI, 把该项目dist目录下的内容拷贝到项目的resources的目录public下。（没有public就新建一个）

六、访问http://localhost:8080/swagger-ui.html 就可以看到效果如下

 

七、UI界面解析（初始页面）

 

 

八、执行后

    

  注：此处为调用接口后，返回的数据。

 

 

    注：此处为对应的返回代码，返回头部。此处可以通过@ApiResponse进行自定义返回信息