iis服务器助手广告广告
返回顶部
首页 > 资讯 > 后端开发 > Python >SpringBoot集成Swagger3的实现
  • 630
分享到

SpringBoot集成Swagger3的实现

2024-04-02 19:04:59 630人浏览 泡泡鱼

Python 官方文档:入门教程 => 点击学习

摘要

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

一,什么是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内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

--结束END--

本文标题: SpringBoot集成Swagger3的实现

本文链接: https://www.lsjlt.com/news/161167.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • SpringBoot集成Swagger3的实现
    目录一,什么是swagger?二,SpringBoot 集成swagger3三,swagger3 注解标签使用一,什么是swagger? 1,  Swagger 是一...
    99+
    2024-04-02
  • SpringBoot如何集成Swagger3
    这篇文章主要介绍SpringBoot如何集成Swagger3,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们一定要看完!一,什么是swagger1,  Swagger 是一个规范和完整的文档框架,   ...
    99+
    2023-06-22
  • 关于springboot集成swagger3时spring-plugin-core报错的问题
    springboot集成knife4j的时候3.0.2版本出现了以下问题: An attempt was made to call a method that does not e...
    99+
    2024-04-02
  • SpringBoot集成drools的实现示例
    目录1、背景2、需求3、实现3.1 引入jar包3.2 编写drools配置类3.3 编写Person对象3.4 编写drl文件3.5 编写kmodule.xml文件3.6 编写Co...
    99+
    2024-04-02
  • springboot集成camunda的实现示例
    目录1、说明2、配置实战3、生成数据库表说明1、说明 camunda使用Java开的工作流引擎。这里使用springboot 2.2.6.release + camunda 3.4...
    99+
    2024-04-02
  • SpringBoot集成cache缓存的实现
    前言   日常开发中,缓存是解决数据库压力的一种方案,通常用于频繁查询的数据,例如新闻中的热点新闻,本文记录springboot中使用cache缓存。   官方文档介绍:https:...
    99+
    2024-04-02
  • Springboot集成swagger实现方式
    Swagger 提供了一个全新的维护 API 文档的方式,有4大优点: 自动生成文档:只需要少量的注解,Swagger 就可以根据代码自动生成 API 文档,很好的保证了文...
    99+
    2024-04-02
  • SpringBoot Admin2.0集成Arthas的实现步骤
    小编给大家分享一下SpringBoot Admin2.0集成Arthas的实现步骤,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧!项目最初使用 Arthas 主要有...
    99+
    2023-06-14
  • SpringBoot Admin2.0 集成Arthas的实现步骤
    目录技术选型相关 整体结构实现效果 改造方案1. 整体工程结构2. 外部链接配置 3. 对应 Spring MVC controller 实现 4. Arthas Spring Bo...
    99+
    2024-04-02
  • Springboot集成ProtoBuf的实例
    目录Springboot集成ProtoBuf1、pom.xml引入相关依赖2、新建序列化工具类ProtoBufUtil.java3、新建实体类User.java4、使用方式Proto...
    99+
    2024-04-02
  • springboot集成redis哨兵主从的实现
    目录一、环境二、POM文件三、application.yml配置四、reidsTemplate配置五、单元测试(JUnit4)一、环境 spring boot 2.3.12.RELE...
    99+
    2024-04-02
  • SpringBoot集成Caffeine缓存的实现步骤
    目录Maven依赖 配置 示例 Maven依赖 要开始使用咖啡因Caffeine和Spring Boot,我们首先添加spring-boot-starter-cache和咖啡因Ca...
    99+
    2024-04-02
  • Springboot集成RabbitMQ死信队列的实现
    目录关于死信队列什么样的消息会进入死信队列?场景分析代码实现场景模拟生产者消费者,设置死信队列监听关于死信队列 在大多数的MQ中间件中,都有死信队列的概念。死信队列同其他的队列一样都...
    99+
    2024-04-02
  • 实战SpringBoot集成JWT实现token验证
    目录环境搭建1、新建一个SpringBoot项目Jwt-Demo,引入项目后面需要用到的jar包2、数据库结构3、配置文件application.properties4、Entity...
    99+
    2024-04-02
  • springboot集成postgresql使用怎么实现
    要在Spring Boot应用程序中集成PostgreSQL数据库,可以按照以下步骤进行: 1、添加PostgreSQL依赖在Spr...
    99+
    2024-04-18
    postgresql springboot
  • springboot集成ftp实现文件上传
    本文实例为大家分享了springboot集成ftp实现文件上传的具体代码,供大家参考,具体内容如下 1、FileUtil package io.renren.modules.os...
    99+
    2024-04-02
  • 使用SpringBoot如何实现集成mybatis
    使用SpringBoot如何实现集成mybatis?很多新手对此不是很清楚,为了帮助大家解决这个难题,下面小编将为大家详细讲解,有这方面需求的人可以来学习下,希望你能有所收获。一、使用mybatis-spring-boot-starter添...
    99+
    2023-05-31
    springboot mybatis
  • SpringBoot集成tomcat详解实现过程
    目录SPISpringBoot for Tomcatspring boot 支持目前主流的 servlet 容器,包括 tomcat、jetty、undertow,可以在我们的项目中...
    99+
    2023-02-23
    SpringBoot集成tomcat原理 SpringBoot集成tomcat
  • Springboot集成minio实现文件存储的实现代码
    目录1. 安装部署1.1 Linux 简单部署1.2 Docker 部署2. Spring boot 整合3. 问题记录4. 项目地址在我们平时做项目的时候,文件存储是个很常见的需求...
    99+
    2024-04-02
  • SpringBoot集成Redis并实现主从架构的实践
    目录一、Windows环境下安装Redis设置键值对根据key获取value二、SpringBoot连接Redis(1)使用Jedis类直接连接Redis服务器(2)通过配置文件进行...
    99+
    2024-04-02
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作