首页天道酬勤swagger是干什么的,swagger使用教程

swagger是干什么的,swagger使用教程

张世龙 05-05 21:10 67次浏览

1在1 Swagger分为前端和后端的项目中,后端开发人员必须向前端或其他后端开发人员提供接口文档。 在实际工作中提供完整准确的接口文档是非常耗时和费力的。 可以使用Swagger提供在线界面文档来解决问题,并通过在代码中编写注释来大大提高文档的质量。

2将Swagger pom.xml添加到项目

Swagger依赖的jar软件包dependencygroupidio.spring fox/groupidartifactidspringfox-swagger2/artifactidversion2.7.0/将版本添加到pom文件的ependencydependencygroupidio.spring fox/groupidartifactidspringfox-swagger-ui/artifactidversion2. spon

创建Swagger配置文件,然后单击swagger @ configuration @ enable swagger2publicclassswaggerconfigextendswebmvcconfigurationsupport { @ beanpport 启用{ return new docket (文档类型. swagger _2).pathmapping('/' ).select ) } . APIs (requesthandlerselectors.base package (com.CSS.gxb.rep services.control ' ).paths ) path selectors.any . } @ overrideprotectedvoidaddresourcehandlers (资源手握存储器)/swagger解决静态资源无法访问registry.addresourcehandler ) '的问题registry.addresourcehandler (/swagger-ui.html ).addrresourcer 解决无法访问meta-iions的swagger的js文件是registry.addresourcehandler (/web jars/* * ' ).addresourcelocations (' ) 使用privateapiinfoapiinfo ((returnnewapiinfobuilder ).title ) ) springbootswagger构建API文档().description )简单易行

3.2注释使用说明3.2.1 @Api 说明:

@Api :用于请求的类,说明该类的作用tags='说明该类的作用' value='其参数没有太大意义,所以不需要配置'(父测试没什么用) 3358 www .

3.2.2 @ApiModel,@ apimodelproperty http://www.Sina.com /

@ApiModel :用于响应类,表示返回响应数据的信息@ApiModelProperty :用于属性,响应类的属性http://www.Sina.com/http://www

3.2.3 @ API操作http://www.Sina.com /

@ API操作: '用于请求的方法,描述方法作用' value='描述方法作用' notes='方法注释说明'示例:

结果:

3.2.4 @ApiImplicitParams,@ apiimplicitparam http://www.Sina.com /

@ApiImplicitParams :用于请求的方法,用于表示一组参数说明的@ apiimplicitparam:@ apiimplicitparams注释,指定请求参数的各个方面。 name :参数名称value :参数汉字说明,解释required :参数是否必须传递paramType,参数放在哪里参数类型其他值dataType='Integer' defaultValue :参数的默认值说明:

单一参数

多个参数

注意: paramType必须与参数注释匹配

header -- @RequestHeader

query -- @RequestParam

path (用于rest风格的接口(- @PathVariable

body----@requestbody

form---- requestbody http://www.Sina.com /

单一参数

多个参数(由于没有进行适当的实验,效果应该与单参数相同,可以在后台读取对应的参数值) )。

略; 4总结来说,使用Swagger意味着将相关信息存储在其定义的描述文件中(yml或json格式),并通过维护该描述文件来更新接口文档,或生成各侧代码Springfox-swagger可以扫描代码以生成此描述文件,而不需要维护描述文件。 所有信息都在代码中。 代码是接口文档,接口文档是代码。

linux安装firefox命令,Linux安装rabbitmq