自定义swagger-ui页面

本文详细介绍如何使用Swagger2实现前后端分离项目的API文档自动生成,包括Maven坐标配置、控制器注解应用及实体类说明,同时展示了如何自定义Swagger界面以提升用户体验。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

  就目前而言,我们开发项目大部分都是实现前后端分离的情况,传统的做法,前后端通过一些接口文档或者邮件来进行交流,一旦某个地方更新,就需要实时更新文档说明,就会变得很麻烦,这个时候,swagger2就出来了,能够实时解决这个困难,下面我们看一下效果图。

在这个项目中,首先我们添加相应的maven坐标:

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

 在创建一个配置类:

在controller上添加下我们的controller类和下面的方法上所处理的业务名称

同样,注意在我们的用到的实体类上添加相应的注解说明,如下图所示:

最后,启动项目运行访问:http://localhost:端口号/swagger-ui.html,便出现最开始上面的截图。

  但是,我们有时候会觉得,这个界面可能不太漂亮,那么我们可以自定义这个界面吗?答案是肯定的。下面就是我们自定义页面的截图:

这种页面看起来就舒服多了,我们要做的事情其实就是加入相应的maven坐标:github上有很多优秀的,我个人觉得这个就蛮不错的,所以就选用这个了。

访问地址改为:http://localhost:端口号/docs.html  就可以出现上面的截图的样子了,但是这又出现一个问题 就是万一那天github上这个东西没有了呢  那岂不是就坏了 所以下一节我会演示如何在线生成文档,这样就不会担心我们引用的东西,突然没有了 导致的问题。

以上都为个人搭建和理解,如若有地方有错,欢迎指正。谢谢!!!

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值