认识Swagger
1:认识
是一个规范和完整的框架,用于生成、描述、调用和可视化 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。
作用:
1.接口的文档在线自动生成。
2.功能测试。
是一组开源项目,其中主要要项目如下:
1. -tools:提供各种与进行集成和交互的工具。例如模式检验、 1.2文档转换成 2.0文档等功能。
2. -core: 用于Java/Scala的的实现。与JAX-RS(、、CXF...)、和Play框架进行集成。
3. -js: 用于的实现。
4. -node-: 模块,用于node.js的 web应用框架。
5. -ui:一个无依赖的HTML、JS和CSS集合,可以为兼容API动态生成优雅文档。
6. -:一个模板驱动引擎,通过分析用户资源声明以各种语言生成客户端代码。
2:Maven
版本号请根据实际情况自行更改。
io.
-
2.2.2
io.
--ui
2.2.2
3:创建配置类
在.java同级创建的配置类
package com.swaggerTest; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; /** * Swagger2配置类 * 在与spring boot集成时,放在与Application.java同级的目录下。 * 通过@Configuration注解,让Spring来加载该类配置。 * 再通过@EnableSwagger2注解来启用Swagger2。 */ 2 public class Swagger2 { /** * 创建API应用 * apiInfo() 增加API相关信息 * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现, * 本例采用指定扫描的包路径来定义指定要建立API的目录。 * * @return */ public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.swaggerTest.controller")) .paths(PathSelectors.any()) .build(); } /** * 创建该API的基本信息(这些基本信息会展现在文档页面中) * 访问地址:http://项目实际地址/swagger-ui.html * @return */ private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Spring Boot中使用Swagger2构建RESTful APIs") .description("更多请关注http://www.baidu.com") .termsOfServiceUrl("http://www.baidu.com") .contact("sunf") .version("1.0") .build(); } }
如上代码所示,通过函数创建的Bean之后,()用来创建该Api的基本信息(这些基本信息会展现在文档页面中)。
4:添加文档内容
在完成了上述配置后,其实已经可以生产文档内容,但是这样的文档主要针对请求本身,描述的主要来源是函数的命名,对用户并不友好,我们通常需要自己增加一些说明来丰富文档内容。
使用的注解及其说明:
@Api:用在类上,说明该类的作用。
@:注解来给API增加方法说明。
@ : 用在方法上包含一组参数说明。
@:用来注解来给方法入参增加说明。
@:用于表示一组响应
@:用在@中,一般用于表达一个错误的响应信息
l code:数字,例如400
l :信息,例如"请求参数没填好"
l :抛出异常的类
@:描述一个Model的信息(一般用在请求参数无法使用@注解进行描述的时候)
l @:描述一个model的属性
注意:@的参数说明:
:指定参数放在哪个地方
:请求参数放置于 ,使用@获取
query:请求参数放置于请求地址,使用@RequestParam获取
path:(用于restful接口)-->请求参数的获取:@PathVariable
body:(不常用)
form(不常用)
name:参数名
dataType:参数类型
required:参数是否必须传
true | false
value:说明参数的意思
defaultValue:参数的默认值
例子:
package com.swaggerTest.controller; import org.springframework.stereotype.Controller; import org.springframework.util.StringUtils; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.ResponseBody; import io.swagger.annotations.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; /** * 一个用来测试swagger注解的控制器 * 注意@ApiImplicitParam的使用会影响程序运行,如果使用不当可能造成控制器收不到消息 * * @author SUNF */ "/say")( "SayController|一个用来测试swagger注解的控制器")(value = public class SayController { "/getUserName", method= RequestMethod.GET)(value = "根据用户编号获取用户姓名", notes="test: 仅1和2有正确返回")(value= "query", name = "userNumber", value = "用户编号", required = true, dataType = "Integer")(paramType= public String getUserName(@RequestParam Integer userNumber){ if(userNumber == 1){ return "张三丰"; } else if(userNumber == 2){ return "慕容复"; } else{ return "未知"; } } "/updatePassword")( "修改用户密码", notes="根据用户id修改密码")(value= ({ "query", name = "userId", value = "用户ID", required = true, dataType = "Integer"),(paramType= "query", name = "password", value = "旧密码", required = true, dataType = "String"),(paramType= "query", name = "newPassword", value = "新密码", required = true, dataType = "String")(paramType= }) public String updatePassword(@RequestParam(value="userId") Integer userId, @RequestParam(value="password") String password, @RequestParam(value="newPassword") String newPassword){ if(userId <= 0 || userId > 2){ return "未知的用户"; } if(StringUtils.isEmpty(password) || StringUtils.isEmpty(newPassword)){ return "密码不能为空"; } if(password.equals(newPassword)){ return "新旧密码不能相同"; } return "密码修改成功!"; } }
完成上述代码添加上,启动 Boot程序,访问::8080/-ui.html
如上图,可以看到暴漏出来的控制器信息,点击进入可以看到详细信息。
两个注意点:
1. 会直接影响程序的运行期,如果与方法参数获取使用的注解不一致,会直接影响到参数的接收。
例如:
使用 UI进行测试,接收不到!
2. 还有一个需要注意的地方:
中定义的方法必须在@中显示的指定类型,否则会默认为全类型皆可访问, API列表中会生成多条项目。
如上图:()未指定,结果生成了7条API信息。所以如果没有特殊需求,建议根据实际情况加上。
5: UI面板说明
6:参考
官网 :
Boot & UI :
:
---------------------------------------------------------------------------------------
7:接收对象传参的例子
在POJO上增加
package com.zhongying.api.model.base;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
/**
* 医生对象模型,不要使用该类
* @author SUNF
*
*/
"医生对象模型")
(value=public class DemoDoctor{
"id" ,required=true)
(value=private Integer id;
"医生姓名" ,required=true)
(value=private String name;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String toString() {
return "DemoDoctor [id=" + id + ", name=" + name + "]";
}
}
注意: 在后台采用对象接收参数时,自带的工具采用的是JSON传参, 测试时需要在参数上加入@,正常运行采用form或URL提交时候请删除。
package com.zhongying.api.controller.app; import java.util.ArrayList; import java.util.List; import javax.servlet.http.HttpServletRequest; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.ResponseBody; import com.github.pagehelper.PageInfo; import com.zhongying.api.exception.HttpStatus401Exception; import com.zhongying.api.model.base.DemoDoctor; import io.swagger.annotations.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; /** * 医生类(模拟) * @author SUNF */ "/api/v1")( "DoctorTestController-医生信息接口模拟")(value = public class DoctorTestController { /** * 添加医生 * * 在使用对象封装参数进行传参时,需要在该对象添加注解,将其注册到swagger中 * @link com.zhongying.api.model.base.DemoDoctor * * 注意: 在后台采用对象接收参数时,Swagger自带的工具采用的是JSON传参, * 测试时需要在参数上加入@RequestBody,正常运行采用form或URL提交时候请删除。 * * @param doctor 医生类对象 * @return * @throws Exception */ "/doctor", method= RequestMethod.POST )(value= "添加医生信息", notes="")(value= public String addDoctor(@RequestBody DemoDoctor doctor) throws Exception{ if(null == doctor || doctor.getId() == null){ throw new HttpStatus401Exception("添加医生失败","DT3388","未知原因","请联系管理员"); } try { System.out.println("成功----------->"+doctor.getName()); } catch (Exception e) { throw new HttpStatus401Exception("添加医生失败","DT3388","未知原因","请联系管理员"); } return doctor.getId().toString(); } /** * 删除医生 * @param doctorId 医生ID * @return */ "/doctor/{doctorId}", method= RequestMethod.DELETE )(value= "删除医生信息", notes="")(value= "query", name = "doctorId", value = "医生ID", required = true, dataType = "Integer")(paramType= public String deleteDoctor(@RequestParam Integer doctorId){ if(doctorId > 2){ return "删除失败"; } return "删除成功"; } /** * 修改医生信息 * @param doctorId 医生ID * @param doctor 医生信息 * @return * @throws HttpStatus401Exception */ "/doctor/{doctorId}", method= RequestMethod.POST )(value= "修改医生信息", notes="")(value= "query", name = "doctorId", value = "医生ID", required = true, dataType = "Integer")(paramType= public String updateDoctor(@RequestParam Integer doctorId, @RequestBody DemoDoctor doctor) throws HttpStatus401Exception{ if(null == doctorId || null == doctor){ throw new HttpStatus401Exception("修改医生信息失败","DT3391","id不能为空","请修改"); } if(doctorId > 5 ){ throw new HttpStatus401Exception("医生不存在","DT3392","错误的ID","请更换ID"); } System.out.println(doctorId); System.out.println(doctor); return "修改成功"; } /** * 获取医生详细信息 * @param doctorId 医生ID * @return * @throws HttpStatus401Exception */ "/doctor/{doctorId}", method= RequestMethod.GET )(value= "获取医生详细信息", notes="仅返回姓名..")(value= "query", name = "doctorId", value = "医生ID", required = true, dataType = "Integer")(paramType= public DemoDoctor getDoctorDetail(@RequestParam Integer doctorId) throws HttpStatus401Exception{ System.out.println(doctorId); if(null == doctorId){ throw new HttpStatus401Exception("查看医生信息失败","DT3390","未知原因","请联系管理员"); } if(doctorId > 3){ throw new HttpStatus401Exception("医生不存在","DT3392","错误的ID","请更换ID"); } DemoDoctor doctor = new DemoDoctor(); doctor.setId(1); doctor.setName("测试员"); return doctor; } /** * 获取医生列表 * @param pageIndex 当前页数 * @param pageSize 每页记录数 * @param request * @return * @throws HttpStatus401Exception */ "/doctor", method= RequestMethod.GET )(value= "获取医生列表", notes="目前一次全部取,不分页")(value= ({ "header", name = "token", value = "token", required = true, dataType = "String"),(paramType= "query", name = "pageIndex", value = "当前页数", required = false, dataType = "String"),(paramType= "query", name = "pageSize", value = "每页记录数", required = true, dataType = "String"),(paramType= }) public PageInfogetDoctorList(@RequestParam(value = "pageIndex", required = false, defaultValue = "1") Integer pageIndex, @RequestParam(value = "pageSize", required = false) Integer pageSize, HttpServletRequest request) throws HttpStatus401Exception{ String token = request.getHeader("token"); if(null == token){ throw new HttpStatus401Exception("没有权限","SS8888","没有权限","请查看操作文档"); } if(null == pageSize){ throw new HttpStatus401Exception("每页记录数不粗安在","DT3399","不存在pageSize","请查看操作文档"); } DemoDoctor doctor1 = new DemoDoctor(); doctor1.setId(1); doctor1.setName("测试员1"); DemoDoctor doctor2 = new DemoDoctor(); doctor2.setId(2); doctor2.setName("测试员2"); ListdoctorList = new ArrayList (); doctorList.add(doctor1); doctorList.add(doctor2); return new PageInfo(doctorList); } }
增加:
现在很多请求需要在增加额外参数,可以参考()的做法,使用接收。