SpringBoot中swagger的使用

• 接口文档对前后端开发人员非常重要，swagger 是基于open api规范构建开源工具，

swagger组件有
swagger editor 基于浏览器编辑器，
swagger ui 可视化ui展示描述文件 ，
swagger inspector 和ui组件很像，可以返回更多信息，会保存请求实际参数，
spring fox 是可以根据代码生成接口文档，所以描述文件是根据项目来变化的，不用手动更新，
springboot导入spring-fox依赖就是导入了wagger,
在启动类上添加@EnableSwagger2注解，添加这个注解后表示启动项目就会启动swagger组件，对当前项目全部控制器进行扫描，
访问swagger-ui
启动项目后在浏览器中输入 http://ip:port/swagger-ui.html
在swagger-ui中可视化操作项目接口，

• swagger配置

可以在项目中创建SwaggerConfig 配置对象来进行配置文档内容
Docket对象 通过这个对象配置描述文件信息
通过apis()方法来设置哪些包中的内容被扫描，

• 常用注解

@Api
是类上注解 控制了整个类生成接口信息的内容，属性tags 类的名字 description描述
@ApiOperation 写在方法上的注解，对方法进行描述， 属性value 方法描述 notes 提示信息
@ApiParam 写在方法参数中的注解，用于对参数进行描述，说明一下是否是必填项，属性有 name 参数名字 value参数描述 required是否是必须
@ApiModel是类上注解，主要应用在实体类上，属性value 类名称，description 是描述
@ApiModelproperty可以应用在方法上或是属性上，用于方法参数是应用类型时进行定义描述
@Apilgnore 用于类上方法上参数上，表示被忽视，

• 前后端分离

一般使用vue+springboot
后端：后端控制层 服务层 数据访问层
前端：前端控制层 视图层
前后端交互 API
创建springboot项目 导入对应的依赖

启动swagger界面查看

配置swagger
swagger有自己的配置实例对象 Docket
这个对象方法中有多个属性
apiinfo属性是配置swagger显示的信息
select()配置扫描接口
groupname()配置api文档的分组 配置多个Docket实例可以实现多个分组，多个@bean

到此这篇关于SpringBoot中swagger的使用的文章就介绍到这了,更多相关swagger的使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

最新评论