前后端分离开发
码农在开发的时候,会要求编写接口文档,但是后端在开发的过程中,有时候接口返回的数据结构可能会发生改变这样又会手动的去修改接口文档,手动免不了出错的可能性,并且后端要保证接口的正确性,就得做单元测试,学过测试的都应该知道,一般不会测试自己代码的原因(不包括单元测试)。前端调用接口出错又得去使用第三方的工具(postman)来做测试。这样又会浪费很多的时间。但是swagger这种属于半侵入式的插件比较简单,很好的避免了前后端的交接扯皮。
整合swagger
目前没有使用到配置文件,就为了方便:
- 导包
<!-- Swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
-
springboot上面是通过注解来使用;
三种颜色的箭头代表着对应的内容
@Api:用在请求的类上,表示对类的说明
tags="说明该类的作用,可以在UI界面上看到的注解"
value="该参数没什么意义,在UI界面上也看到,所以不需要配置"
@ApiOperation:用在请求的方法上,说明方法的用途、作用
value="说明方法的用途、作用"
notes="方法的备注说明"
以下是注解的属性
@ApiImplicitParams:用在请求的方法上,表示一组参数说明
@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
name:参数名
value:参数的汉字说明、解释
required:参数是否必须传
paramType:参数放在哪个地方
· header --> 请求参数的获取:@RequestHeader
· query --> 请求参数的获取:@RequestParam
· path(用于restful接口)--> 请求参数的获取:@PathVariable
· body(不常用)
· form(不常用)
dataType:参数类型,默认String,其它值dataType="Integer"
defaultValue:参数的默认值
对应的注解
未完待续。。。。。。。。。