Swagger的原理及应用-成都创新互联网站建设

关于创新互联

多方位宣传企业产品与服务 突出企业形象

公司简介 公司的服务 荣誉资质 新闻动态 联系我们

Swagger的原理及应用

这篇文章主要讲解了“Swagger的原理及应用”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“Swagger的原理及应用”吧!

网站建设、基于HTML5技术的Web开发、手机站开发、微信开发等互联网应用服务。成都创新互联始终关注着互联网行业的前沿动态,创新互联坚信:真诚的态度,勤奋的工作是我们赢得客户信赖的基础;而不断创新、力求完美,才是创新互联共同迈向美好未来的保证。

OpenAPI规范是Linux基金会的一个项目,试图通过定义一种用来描述API格式或API定义的语言,来规范RESTful服务开发过程。

Swagger是全球最大的OpenAPI规范API开发工具框架,支持从设计到文档到测试和部署到整个API生命周期的开发。Spring Boot可以集成Swagger,生成Swagger接口。

在Java类中添加Swagger的注解即可生成Swagger接口。

常用的Swagger注解:

@Api:修饰整个类,描述Controller的作用,

@ApiOperation:描述一个类的一个方法,或者说一个接口

@ApiParam:单个参数描述

@ApiModel:用对象来接收参数

@ApiModelProperty:用对象接收参数时,描述对象的一个字段

@ApiResponse:HTTP响应其中1个描述

@ApiResponses:HTTP响应整体描述

@ApiIgnore:使用该注解忽略这个API

Swagger接口生成工作原理:

1、系统启动时,扫描Swagger的配置类

2、在此类中指定来要扫描的包路径,找到在此包下及子包下标记@RestController注解的controller类

3、根据controller类中的Swagger注解生成接口文档

启动项目,访问项目虚拟路径/swagger-ui,查看生成的项目

@ApiError:发送错误返回的信息

@ApiImplicitParam:一个请求参数

@ApiImplicitParams:多个请求参数

感谢各位的阅读,以上就是“Swagger的原理及应用”的内容了,经过本文的学习后,相信大家对Swagger的原理及应用这一问题有了更深刻的体会,具体使用情况还需要大家实践验证。这里是创新互联,小编将为大家推送更多相关知识点的文章,欢迎关注!


网站名称:Swagger的原理及应用
路径分享:http://kswsj.cn/article/gcpici.html

其他资讯