首页天道酬勤,

,

张世龙 05-05 21:11 102次浏览

界面文档对前端开发人员非常重要,swagger基于open api规范构建开源工具。

swagger组件包括

swagger editor基于浏览器编辑器。

swagger ui可视化ui演示文稿描述文件,

swagger inspector类似于ui组件,可以返回更多信息,并存储请求的实际参数。

spring fox可以通过代码生成接口文档,因此说明文件随项目而变化,无需手动更新

springboot引入spring-fox依赖是因为引入了wagger,

向启动类中添加@EnableSwagger2注释。 添加此注释后,启动项目将启动swagger组件并扫描当前项目中的所有控制器。

访问swagger-ui

启动项目后,在浏览器中输入http://IP :端口/swagger-ui.html

通过swagger-ui可视化操作项目接口,

swagger配置

可以在项目中创建SwaggerConfig配置对象来配置文档内容

Docket对象使用此对象配置来描述文件信息

apis ) )方法设置扫描哪些软件包的内容。

常用评论

@Api

类上的注释控制整个类生成接口信息的内容,属性tags类的名称description将说明

写在@ApiOperation方法上的注释描述方法,属性value方法描述notes提示信息

写给@ApiParam方法参数的注释。 用于说明参数,说明是否必须,属性中有name参数名value参数,是否必须要求

@ApiModel是类上的注释,主要应用于实体类,属性value类名,说明为

@ApiModelproperty可应用于方法或属性,用于在方法参数为应用类型时进行定义和描述

@Apilgnore用于类上方法上的参数,表示将被忽略。

前后端分离

通常使用vue springboot

后端:后端控制层服务层数据访问层

前端:前端控制层

前后交互API

创建与导入springboot项目相对应的依赖关系

启动并显示swagger界面

swagger配置

swagger有自己的配置实例对象Docket

此对象方法具有多个属性

apiinfo属性用于设置swagger中显示的信息

配置select ()扫描接口

groupname ) )配置api文档的组配置通过配置多个Docket实例,可以实现多个组、多个@bean

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