SpringBoot集成Swagger3的实现

目录
  • 一，什么是swagger?
  • 二，SpringBoot 集成swagger3
  • 三，swagger3 注解标签使用

一，什么是swagger?

1,  Swagger 是一个规范和完整的文档框架，

    用于生成、描述、调用和可视化 RESTful 风格的 Web 服务文档

    官方网站:https://swagger.io/

2，使用swagger要注意的地方:

     在生产环境中必须关闭swagger,

     它本身只用于前后端工程师之间的沟通,

     可以专门使用一台内部服务器来展示ui供访问,

     即使在这上面要做好安全措施

3,  因为swagger3.0.0已发布，本文使用了最新版

     如果有还在用2.x版本的请参考时注意区分

二，SpringBoot 集成swagger3

 pom.xml 集成Swagger3依赖

        <!-- swagger3 接口文档生成器 -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-boot-starter</artifactId>
			<version>3.0.0</version>
			<exclusions>
				<exclusion>
					<groupId>org.springframework.plugin</groupId>
					<artifactId>spring-plugin-core</artifactId>
				</exclusion>
				<exclusion>
					<groupId>org.springframework.plugin</groupId>
					<artifactId>spring-plugin-metadata</artifactId>
				</exclusion>
			</exclusions>
		</dependency>

Swagger3 配置对象定义

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
@EnableOpenApi
public class Swagger3Config {
	@Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.digipower.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("在奋斗的大道上 - 微信预约查档系统").termsOfServiceUrl("https://blog.csdn.net/zhouzhiwengang")
				.description("API接口")
				.contact(new Contact("https://blog.csdn.net/zhouzhiwengang","",""))
				.version("3.0").build();
    }

}

SpringBoot 集成Swagger3 接口文档效果截图

 SpringBoot 访问Swagger3接口文档地址

默认接口访问地址:http://192.168.0.1:5988/swagger-ui/

三，swagger3 注解标签使用

@ApiModel用于类上面说明功能

@ApiModelProperty用于字段上说明功能

示列截图：

@Api用来指定一个controller中的各个接口的通用说明

@ApiOperation用来说明一个方法

@ApiImplicitParams:用来包含多个包含多个 @ApiImplicitParam

@ApiImplicitParam:用来说明一个请求参数 

示列截图：

 温馨提示：针对任何请求参数结构说明，请一定记得要添加@ApiParam 标签，如果不添加@ApiParam标签，在Swagger3文档中针对参数结构说明就是空

到此这篇关于SpringBoot集成Swagger3的实现的文章就介绍到这了,更多相关SpringBoot集成Swagger3内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

赞 (0)

相关推荐

  • SpringBoot集成Swagger构建api文档的操作

    SpringBoot集成Swagger构建api文档的操作

    最近在做项目的时候,一直用一个叫做API的东西,controller注解我会写,这个东西我也会用,但是我确实不知道这个东西是个什么,有点神奇.关键还坑了我一次,他的注解会影响到代码的运行,不光是起到注解的作用.所以我就研究了一下. Swagger是什么:THE WORLD'S MOST POPULAR API TOOLING 根据官网的介绍: Swagger Inspector:测试API和生成OpenAPI的开发工具.Swagger Inspector的建立是为了解决开发者的三个主要目标. 1

  • springboot2.x集成swagger的方法示例

    集成swagger pom包配置 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <!-- swagger-ui --> <dependency> <groupId>io

  • 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集成Swagger2生成接口文档的方法示例

    我们提供Restful接口的时候,API文档是尤为的重要,它承载着对接口的定义,描述等.它还是和API消费方沟通的重要工具.在实际情况中由于接口和文档存放的位置不同,我们很难及时的去维护文档.个人在实际的工作中就遇到过很多接口更新了很久,但是文档却还是老版本的情况,其实在这个时候这份文档就已经失去了它存在的意义.而 Swagger 是目前我见过的最好的API文档生成工具,使用起来也很方便,还可以直接调试我们的API.我们今天就来看下 Swagger2 与 SpringBoot 的结合. 准备工作

  • Springboot集成swagger实现方式

    Swagger 提供了一个全新的维护 API 文档的方式,有4大优点: 自动生成文档:只需要少量的注解,Swagger 就可以根据代码自动生成 API 文档,很好的保证了文档的时效性. 跨语言性,支持 40 多种语言. Swagger UI 呈现出来的是一份可交互式的 API 文档,我们可以直接在文档页面尝试 API 的调用,省去了准备复杂的调用参数的过程. 还可以将文档规范导入相关的工具(例如 SoapUI), 这些工具将会为我们自动地创建自动化测试. 如何实现swagger 一: pom文件

  • 关于springboot集成swagger3时spring-plugin-core报错的问题

    springboot集成knife4j的时候3.0.2版本出现了以下问题: An attempt was made to call a method that does not exist. The attempt was made from the following location:       springfox.documentation.schema.plugins.SchemaPluginsManager.viewProvider(SchemaPluginsManager.java

  • SpringBoot集成Swagger2的方法

    SpringBoot集成Swagger2的方法

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

  • 教你利用springboot集成swagger并生成接口文档

    教你利用springboot集成swagger并生成接口文档

    效果图 实现步骤 1.maven中引入jar包,不同版本的swagger可能页面效果不一样. <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.1</version> </dependency> <dependency> <groupId&g

  • SpringBoot集成Swagger3的实现

    SpringBoot集成Swagger3的实现

    目录 一,什么是swagger? 二,SpringBoot 集成swagger3 三,swagger3 注解标签使用 一,什么是swagger? 1,  Swagger 是一个规范和完整的文档框架,     用于生成.描述.调用和可视化 RESTful 风格的 Web 服务文档     官方网站:https://swagger.io/ 2,使用swagger要注意的地方:      在生产环境中必须关闭swagger,      它本身只用于前后端工程师之间的沟通,      可以专门使用一台内

  • springboot集成swagger3与knife4j的详细代码

    springboot集成swagger3与knife4j的详细代码

    目录 springboot集成swagger3 swagger3的springboot启动器jar包 编写TestController代码 创建Swagger3Configuration 运行演示 对接口进行注解 swagger中常用的注解 接口基本使用 运行结果 集成更好的UI-knife4j maven 启动器 springboot集成swagger3 swagger3的springboot启动器jar包 <!-- https://mvnrepository.com/artifact/io.

  • 全网最全SpringBoot集成swagger的详细教程

    全网最全SpringBoot集成swagger的详细教程

    目录 一. 接口文档概述 二. SpringBoot集成swagger2 2.1 引入依赖 2.2 引入配置 2.3 给Controller 添加注解 2.4 [404]问题解决 2.5 替换UI 三. SpringBoot集成swagger3 四. swaggerUI 拦截器和跨域冲突处理 五. 写在最后 一. 接口文档概述 swagger是当下比较流行的实时接口文文档生成工具.接口文档是当前前后端分离项目中必不可少的工具,在前后端开发之前,后端要先出接口文档,前端根据接口文档来进行项目的开发

  • Java开发SpringBoot集成接口文档实现示例

    Java开发SpringBoot集成接口文档实现示例

    目录 swagger vs smart-doc Swagger的代码侵入性比较强 原生swagger不支持接口的参数分组 简单罗列一下smart-doc的优点 SpringBoot集成 smart-doc 引入依赖,版本选择最新版本 新建配置文件smart-doc.json 通过执行maven 命令生成对应的接口文档 访问接口文档 功能增强 1. 开启调试 2. 通用响应体 3. 自定义Header 4. 参数分组 5. idea配置doc 6. 完整配置 小结 之前我在SpringBoot老鸟

  • springboot2.6.4集成swagger3.0遇到的坑及解决方法

    springboot2.6.4集成swagger3.0遇到的坑及解决方法

    Swagger简介 号称:世界上最流行的API框架 PestFul API文档在线自动生成器 --> API文档与API定义同步更新可以直接运行,测试API接口 支持多种语言 强调:我的springboot版本2.6.4,swagger为3.0,其他版本可能修改不成功,大家可以试试. 在集成的时候出现了很多问题 坑一:首先先排除问题 ,我使用的springboot版本2.6.4,导入的swagger依赖如下 <dependency> <groupId>io.springfox

  • 详解Spring-Boot集成Spring session并存入redis

    详解Spring-Boot集成Spring session并存入redis

    spring Session 提供了一套用于管理用户 session 信息的API和实现. Spring Session为企业级Java应用的session管理带来了革新,使得以下的功能更加容易实现: 编写可水平扩展的原生云应用. 将session所保存的状态卸载到特定的外部session存储中,如Redis或Apache Geode中,它们能够以独立于应用服务器的方式提供高质量的集群. 当用户使用WebSocket发送请求的时候,能够保持HttpSession处于活跃状态. 在非Web请求的处

  • SpringBoot集成Spring Data JPA及读写分离

    相关代码: github OSCchina JPA是什么 JPA(Java Persistence API)是Sun官方提出的Java持久化规范,它为Java开发人员提供了一种对象/关联映射工具 来管理Java应用中的关系数据.它包括以下几方面的内容: 1.ORM映射 支持xml和注解方式建立实体与表之间的映射. 2.Java持久化API 定义了一些常用的CRUD接口,我们只需直接调用,而不需要考虑底层JDBC和SQL的细节. 3.JPQL查询语言 这是持久化操作中很重要的一个方面,通过面向对象

  • 详解SpringBoot集成jsp（附源码）+遇到的坑

    详解SpringBoot集成jsp（附源码）+遇到的坑

    本文介绍了SpringBoot集成jsp(附源码)+遇到的坑 ,分享给大家 1.大体步骤 (1)创建Maven web project: (2)在pom.xml文件添加依赖: (3)配置application.properties支持jsp (4)编写测试Controller (5)编写JSP页面 (6)编写启动类App.java 2.新建SpringInitialzr 3.pom文件 <dependencies> <dependency> <groupId>org.s

  • SpringBoot集成Swagger2实现Restful(类型转换错误解决办法)

    pom.xml增加依赖包 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <

随机推荐