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的使用内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

赞 (0)

相关推荐

  • springboot如何集成Swagger2

    springboot如何集成Swagger2

    一.是什么 当下很多公司都采取前后端分离的开发模式,前端和后端的工作由不同的工程师完成.在这种开发模式下,维持一份及时更新且完整的 Rest API 文档将会极大的提高我们的工作效率.传统意义上的文档都是后端开发人员手动编写的,相信大家也都知道这种方式很难保证文档的及时性,这种文档久而久之也就会失去其参考意义,反而还会加大我们的沟通成本.而 Swagger 给我们提供了一个全新的维护 API 文档的方式. 二.为什么要使用它 1.代码变更,文档跟着代码变.只需要少量的注解Swagger就可以根据

  • SpringBoot集成Swagger2构建在线API文档的代码详解

    SpringBoot集成Swagger2构建在线API文档的代码详解

    第一部分:代码集成 pom.xml <!--swagger2配置--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.4.0</version> </dependency> <dependency> <groupId>i

  • springboot使用swagger-ui 2.10.5 有关版本更新带来的问题小结

    springboot使用swagger-ui 2.10.5 有关版本更新带来的问题小结

    问题1 常见问题 1.需要传入后台的为string类型 但是使用swagger-ui 接口进行测试的时候,输入的为数字类型,建议对pom.xml文件进行调整 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>${swagger.version}</version> </de

  • SpringBoot集成Swagger2的方法

    SpringBoot集成Swagger2的方法

    一.是什么 当下很多公司都采取前后端分离的开发模式,前端和后端的工作由不同的工程师完成.在这种开发模式下,维持一份及时更新且完整的 Rest API 文档将会极大的提高我们的工作效率.传统意义上的文档都是后端开发人员手动编写的,相信大家也都知道这种方式很难保证文档的及时性,这种文档久而久之也就会失去其参考意义,反而还会加大我们的沟通成本.而 Swagger 给我们提供了一个全新的维护 API 文档的方式. 二.为什么要使用它 1.代码变更,文档跟着代码变.只需要少量的注解Swagger就可以根据

  • SpringBoot整合Swagger3生成接口文档过程解析

    前后端分离的项目,接口文档的存在十分重要.与手动编写接口文档不同,swagger是一个自动生成接口文档的工具,在需求不断变更的环境下,手动编写文档的效率实在太低.与新版的swagger3相比swagger2配置更少,使用更加方便. 一.pom文件中引入Swagger3依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId

  • SpringBoot 开发提速神器 Lombok+MybatisPlus+SwaggerUI

    SpringBoot 开发提速神器 Lombok+MybatisPlus+SwaggerUI

    导读 Lombok:可以让你的POJO代码特别简洁,不止简单在BO/VO/DTO/DO等大量使用,还有设计模式,对象对比等 MybatisPlus:增加版Mybatis,基础的数据库CRUD.分页等可以直接生成使用,避免了大量的重复低效代码,还有数据库自动Java类,sql文件等等,比传统的更贱简介易用 SwaggerUI:接口文档自动生成,对接前端和测试更加方便,基于业界的OpennApi规范,采用Swagger3.x版本. 技术栈 SpringBoot2.4+ MybatisPlus+Lom

  • 关于springboot整合swagger问题及解决方法

    关于springboot整合swagger问题及解决方法

    一.前言 解决了一个困扰很久的问题.自己搭建的一个springboot项目,整合完jsp之后可以正常访问前端界面,但当再整合上swagger之后,前端界面就无法访问了.当注释掉swagger之后,前端界面又可以正常访问. 二.整合jsp 1.pom引入 <!-- 添加jsp引用 --> <dependency> <groupId>org.apache.tomcat.embed</groupId> <artifactId>tomcat-embed-

  • SpringBoot整合Swagger2的示例

    一.导入maven包 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <a

  • SpringBoot如何优雅地使用Swagger2

    前言 Spring Boot 框架是目前非常流行的微服务框架,我们很多情况下使用它来提供 Rest API.而对于 Rest API 来说很重要的一部分内容就是文档,Swagger 为我们提供了一套通过代码和注解自动生成文档的方法,这一点对于保证 API 文档的及时性将有很大的帮助.本文将使用 Swagger 2 规范的 Springfox 实现来了解如何在 Spring Boot 项目中使用 Swagger,主要包含了如何使用 Swagger 自动生成文档.使用 Swagger 文档以及 Sw

  • 关于springboot集成swagger及knife4j的增强问题

    关于springboot集成swagger及knife4j的增强问题

    参考链接:狂神的Swagger笔记 号称世界上最流行的API框架 Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新 直接运行,在线测试API 支持多种语言 (如:Java,PHP等) 官网:swagger SpringBoot集成Swagger 添加maven依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2&

  • springboot 配置使用swagger2操作

    swagger是一个功能强大的在线API文档的框架,提供了优雅的API在线文档的查阅和测试功能. 利用swagger2可以很方便的构建RESTful风格的API文档,在springboot中使用也非常方便,主要是在controller前配置添加注解就可以了,详细配置过程如下: 1. maven依赖包 使用目前最新版本为例,pom.xml添加的代码如下 <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui

  • 手把手教你SpringBoot快速集成Swagger的配置过程

    手把手教你SpringBoot快速集成Swagger的配置过程

    导语 相信大家无论是做前端还是做后端的,都被接口接口文档所折磨过,前端抱怨接口文档和后端给的不一致,后端抱怨写接口文档很麻烦,所以Swagger就诞生了.直接配置即可自动生成接口文档,而且提供了高效的API测试 话不多说直接开干 导入SpringBoot集成Swagger所需要的依赖 <!--web方便测试--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId&g

  • SpringBoot整合Swagger2的步骤详解

    SpringBoot整合Swagger2的步骤详解

    简介 swagger是一个流行的API开发框架,这个框架以"开放API声明"(OpenAPI Specification,OAS)为基础, 对整个API的开发周期都提供了相应的解决方案,是一个非常庞大的项目(包括设计.编码和测试,几乎支持所有语言). springfox大致原理: springfox的大致原理就是,在项目启动的过种中,spring上下文在初始化的过程, 框架自动跟据配置加载一些swagger相关的bean到当前的上下文中,并自动扫描系统中可能需要生成api文档那些类,

随机推荐