首页天道酬勤,

,

张世龙 05-05 21:22 66次浏览

认识Swagger:

Swagger是用于生成、描述、调用和可视化具有rest风格的Web服务的规范和完整框架。 总体目标是将客户端和文件系统作为服务器以相同的速度更新。 的方法。 参数和模型紧密集成到服务器端代码中,以确保API始终保持同步。

角色:

1 .界面文档在线自动生成。

2 .功能测试。

Swagger使用的注释及其说明:

@Api :用于类,说明该类的作用。 @ API操作:用于向API添加方法说明的注释。 @ApiImplicitParams :用于在方法中包含参数说明。 @ApiImplicitParam :用于向方法的参与添加说明的注释。 参数:paramType :指定参数放在哪里header :请求参数放在Request Header中,使用@RequestHeader获取query :请求参数放在请求地址@RequestParam获取path:(用于rest风格的接口) -获取请求参数) @PathVariable body:(紧急)form (紧急) )name )参数名称根值@ API响应:用于表示一系列响应的@ API响应: @ API响应,通常用于一个错误的响应信息——code :数字,例如400354 ——响应: @ API响应@ApiImplicitParam注释无法描述时一般使用。 @ApiModelProperty描述两个Model属性的第一步:依赖软件包(

ependencygroupidio.spring fox/groupidartifactidspringfox-swagger2/artifactidversion2.2.2/version/从属群体共享pringfox-swagger-ui/artifactidversion 2.2/version/dependency第2步: Swagger2配置类中的

@ configuration @ enable swagger2public class swagger2{/* * *创建API APP应用程序* apiInfo ()添加API相关信息select ) }函数中,使用@ beanpublicdocketcreaterestapi ((返回新文档) documentationtype.Swagger_2).APIinfo ) API info.APIs (请求程序controller ) ).paths ) pathselectors.any ) ).path } /** *用于创建此API的基本信息(这些基本信息位于文档页面上(*访问@return*/privateAPIinfoAPIinfo ) ) returnnewapiii.title (在spring boot上使用Swagger2进行rest风格的APIs ) )、description )、

使用createRestApi函数创建Docket的Bean后(apiInfo ) )用于创建该Api的基本信息,如上面的代码所示。 这些基本信息显示在文档页面上。

使用步骤Swagger提供的注释

/** * @Auther:折戟沉沙* @Description:简表-演示* @ version :1.0 */@ rest controller @ request mapping (/OSS ) 描述='用于演示swagger的注释') publicclasstestcontroller { @ API操作(value='更改用户密码),notes='用户iid @ apiimplicitparams ({ @ apiimplicitparam (param type=' query ',name='userId ',value='用户id ' datatype=' integype ) name='password ',value='旧密码',required=true @ apiimplicitparam (param type=' query ',name='newPassword ' dataType='String ' ) }@requestmapping(/更新密码) ) publicstringupdatepassword ) @requestparam ) value=' '请求参数@ request param (value=' passworrd ) } if (string utils.isempty (password ) ) { return '密码不能为空(; } if (password.equals (new password ) ) { return )新旧密码不能相同); } return '密码更改成功!' ; 启动Spring Boot程序并访问http://locahost :8080/swagger-ui.html

参考文献:

1.https://blog.csdn.net/sanyaoxu _2/article/details/80555328

Swagger官网: http://swagger.io/

springbootswaggerui:http://fruzenshtein.com/spring-boot-swagger-ui /

github:https://github.com/swagger-API/swagger-core/wiki/annotations

作者:纬一

链接: https://www.Jian Shu.com/p/66 a 14 ea 07622

资料来源:简本

版权归作者所有。 商业转载请联系作者取得许可。 非商业转载请注明出处。

,