java 整合 swagger-ui 步骤

news2024/11/15 11:14:13

1.在xml 中添加Swagger 相关依赖

		<!-- springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!-- springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

2.配置Swagger

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


@Configuration
@EnableSwagger2
public class SwaggerConfig {
    /*
     * 1.配置生成的文档信息
     * 2.配置生成规则
     * */

    //Docket封装接口文档信息
    @Bean
    public Docket
    getDocket(){

        //创建封面信息对象
        ApiInfoBuilder apiInfoBuilder = new ApiInfoBuilder();
        apiInfoBuilder.title("《xx项目》接口说明")
                .description("此文档详细说明了xxx项目接口规范")
                .version("v 0.0.1")
                .contact(new Contact("","",""));
        ApiInfo apiInfo = apiInfoBuilder.build();

        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xxxxxx.controller"))
                .build();

        return docket;
    }

}

3.启动项目,访问 Swagger UI
访问地址:http://localhost:xxx/swagger-ui.html出现下面界面则配置成功在这里插入图片描述

4.更改界面风格
4.1 添加依赖

 		<dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

4.2 启动项目,并访问
访问地址:http://localhost:xxxx/doc.html
4.3效果
在这里插入图片描述
5.Swagger 注解

常用的注解
@API类注解,在控制器类添加此注解,可以对控制器类进行功能说明
示例:@Api(value = "提供xx相关接口",tags = "xx管理")

@ApiOperation是用于构建Api文档的注解,它用于标识一个HTTP请求的方法,并描述该方法的作用、请求方式、响应等信息。
@ApiOperation(value = "XXXX接口", httpMethod = "POST", notes = "XXXXXX")

@ApiModelProperty:用于定义API模型的字段,包括字段名、描述、类型等信息。
@ApiModelProperty(value = "xxxx",required = true,example = "xxxx")//required = true 表示该字段为必填字段,example 表示:示例xxx

@ApiIgnore 注解的主要作用是忽略特定的类、方法或方法参数,使其在 Swagger 生成的 API 文档中不显示。
用法:
	@ApiIgnore 注解可以应用于以下三个方面:
	类:当应用于类时,整个类将被忽略,不会在 Swagger 生成的 API 文档中显示。
	方法:当应用于方法时,该方法将被忽略,不会在 Swagger 生成的 API 文档中显示。
	参数:当应用于方法参数时,该参数将被忽略,不会在 Swagger 生成的 API 文档的参数列表中显示。

6.遇见的问题

@ApiModelProperty(value = "xxxx",example = "xxxx")
变量上添加了注解 但是不起作用原因:
1.属性名或属性值不符合规范。例如,属性名应该遵循驼峰命名法,且第二个字母不能大写。另外,对于Boolean类型的字段,字段名应该以is开头。(我遇见的是变量命名不规范导致的)
2.在Controller接口层,需要直接返回使用@ApiModel注解的实体类,或者集合-泛型为使用@ApiModel注解的实体类。

在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/985713.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

2023年05月 C/C++(八级)真题解析#中国电子学会#全国青少年软件编程等级考试

C/C编程&#xff08;1~8级&#xff09;全部真题・点这里 第1题&#xff1a;道路 N个以 1 … N 标号的城市通过单向的道路相连:。每条道路包含两个参数&#xff1a;道路的长度和需要为该路付的通行费&#xff08;以金币的数目来表示&#xff09; Bob and Alice 过去住在城市 1.在…

阿里云云主机免费试用三个月

试用链接如下&#xff1a; 阿里云云产品免费试用 云主机 费用试用三个月&#xff0c;每月750小时 实例规格 1核(vCPU) 2 GiB S6 系列机型 适用搭建网站等场景 网络带宽 1M 公网固定网络带宽 云盘40 GiB 真香&#xff01;&#xff01;&#xff01;&#xff01;&#xff01;&…

【经验分享】如何使用VSCode对比两个文件

问题&#xff1a; 当有两个不同版本的文件&#xff0c;如何使用VSCode对比两个文件 解决办法 长按ctrl选择想要对比的两个文件-----右键选择将已选项进行比较----大功告成 大功告成

Light Matrix、鲁比尼拳击场和 The Sandbox 联合推出鲁比尼拳击元宇宙

The Sandbox 非常高兴地宣布与 Light Matrix 以及鲁比尼拳击场达成战略合作。作为合作的一部分&#xff0c;The Sandbox、LightMatrix 和鲁比尼拳击场将共同创作「鲁比尼拳击场」&#xff0c;这是第一个在全球范围内展示泰拳艺术和泰拳故事的项目。该项目由 Demo Corporation 开…

算法:数组中的最大差值---“打擂台法“

1、题目&#xff1a; 给定一个整数数组 nums&#xff0c;找出给定数组中两个数字之间的最大差值。要求&#xff0c;第二个数字必须大于第一个数字。 2、分析特点&#xff1a; 求最大差值 > 最大值 - 最小值只需要遍历价格数组一遍&#xff0c;记录历史最小值&#xff0c;非…

DeepStream-gst-dsexample

gst-dsexample是个例子插件&#xff0c;你可以修改定制里的实现。你可以blur原图像&#xff0c;也可以填加新的meta. 变量解释 host_rgb_buf是根据用户设置的宽高processing_width/processing_height,创建的hostcuda内存&#xff0c;需要主要的是&#xff0c;它的格式RGB。 …

接口加密了该怎么测?

对明文编码生成信息摘要&#xff0c;以防止被篡改。比如MD5使用的是Hash算法&#xff0c;无论多长的输入&#xff0c;MD5都会输出长度为128bits的一个串。 摘要算法不要秘钥&#xff0c;客户端和服务端采用相同的摘要算法即可针对同一段明文获取一致的密文。 一、对称加密 对…

孙哥Spring源码第19集

第19集 refresh()-invokeBeanFactoryPostProcessor 三- Import三种形式的处理过程 【视频来源于&#xff1a;B站up主孙帅suns Spring源码视频】【微信号&#xff1a;suns45】 1、ImportBeanDefinitionRegister的处理过程 在processImports处理Import注解中 ImportBeanDefinit…

数据结构 - 双向链表

文章目录 目录 文章目录 前言 一、什么是双向链表? 双向链表有什么优势? 二、双向链表的设计和实现 1.设计思想 尾增 : 在链表的末尾添加新的元素 头插 : 在链表头部插入节点 删除 : 根据val的值删除节点 查找 : 根据索引的值查找并返回节点 总结 前言 大家好,今天给…

Window安装虚拟机+给虚拟机安装Linux

一、虚拟机下载 这里使用Virtualbox虚拟机。可以直接从官网下载&#xff1a;Downloads – Oracle VM VirtualBox 点击进行下载&#xff0c;选择window版本的。直接双击&#xff0c;一直下一步 进行安装 PS&#xff1a;安装需要开启CPU虚拟化&#xff0c;一般电脑都已经开启了…

【大麦小米学量化】使用天勤TqSdk实现期货量化交易(入门)

文章目录 酱香拿铁的故事一、TqSdk 是什么&#xff1f;二、准备工作1. 安装tqsdk库&#xff08;Python环境提前准备好&#xff09;2. 注册快期账户3. 支持的期货公司&#xff08;更新以官方公布为准&#xff09; 三、初试牛刀1. 示例代码&#xff1a;2. 运行后提示如下&#xf…

VIT中的einops包详解

‘’‘einops有三个常用方法&#xff1a;rearrange,repeat,reduce’‘’ rearrange的操作相当于转置 rearrange(image,‘h w c -> w h c’) 高和宽转置 path ../data/cat_and_mouse.jpg image cv2.imread(path) h,w,c image.shape # shape第一个值是h,第二个是w image…

Vue框架--Vue列表渲染(1)

1.列表的基本遍历 Vue提供了v-for用于遍历数据内容,我们在这里重点说两种数据的遍历:数组的遍历和对象的遍历。遍历数组对象如下所示: 遍历对象案例:

vue3项目部署报错 Faled to esolve entry for pacdlage “hntlify/sthared“

版本 vue 3.2.47 vue-i18n 9.2.2 本地运行没有问题&#xff0c;jenkins上部署报错找不到"hntlify/sthared"包 排查问题&#xff1a; 查看vue-i18n官网&#xff0c;发现有引用到这个包 “hntlify/sthared” vue-i18n最新版本是9.3.0&#xff0c;未锁定版本&#xf…

Excel 将数字添加百分号

目的&#xff1a;将56.33变成56.33% 打一个“100”&#xff0c;然后ctrlc复制 全选要操作的数据&#xff0c;右键&#xff0c;选择“选择性张贴” 选择“除” 再选择“百分比” 可以调整位数 软件工程小施同学 20230907

【0907 C高级day2】Shell脚本

一、作业&#xff1a;写一个shell脚本&#xff0c;将以下内容放到脚本中 在家目录下创建目录文件&#xff0c;dir在dir下创建dir1和dir2把当前目录下的所有文件拷贝到dir1中&#xff0c;把当前目录下的所有脚本文件拷贝到dir2中把dir2打包并压缩为dir2.tar.xz再把dir2.tar.xz移…

Mac上的视频管理神器:MetaVideo for Mac让你的视频搜索和整理更轻松

视频时代已经来临&#xff0c;我们每天都会接触到各种各样的视频资源。但是&#xff0c;如何管理和编辑这些视频文件&#xff0c;让它们更加易于查找和使用呢&#xff1f;MetaVideo for Mac可以帮助你解决这个问题。 MetaVideo for Mac是一款专门为Mac用户设计的视频管理软件&…

2023京东医疗保健器械行业数据分析(京东数据分析平台)

随着人们对自身健康的重视程度不断加深&#xff0c;当前市场中各类对疾病具有诊断、预防、监护、治疗或者缓解的医疗保健仪器越来越受到消费者的关注。 根据鲸参谋电商数据分析平台的相关数据显示&#xff0c;今年7月份&#xff0c;京东平台医疗保健仪器的销量为950万&#xf…

Java“牵手”1688商品详情数据,1688商品详情API接口,1688API接口申请指南

1688平台商品详情接口是开放平台提供的一种API接口&#xff0c;通过调用API接口&#xff0c;开发者可以获取1688商品的标题、价格、库存、月销量、总销量、库存、详情描述、图片等详细信息 。 获取商品详情接口API是一种用于获取电商平台上商品详情数据的接口&#xff0c;通过…