项目配置swagger(亲测能用)

2024-08-27 21:38
文章标签 配置 项目 swagger 亲测

本文主要是介绍项目配置swagger(亲测能用),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

 

项目配置swagger---(亲测能用)


 

一,前言

      Swagger的好处这里就不在敷衍了, 高效简洁界面优美节省时间等等读者可以自己去查,本博文主要是介绍怎么从零开始,将swagger 添加配置到一个项目中去.

 

  之前公司团队重要有人研究了 swagger, 推向了整个公司, 大大的提升了公司,开发人员的效益,当时自己只是停留在会用,感觉非常的高效好用阶段,没有自己动手从零开始配置,几年后这次换一家公司,很多人还是用 postman这个相对效率低下的工具,索性我就自己拾起 swagger 并将其推向自己的团队.

 

二,问题

   怎么讲 swagger 从零配置到一个项目中?

 

三,解决方案:

1,查了很多的教程,博客, 也尝试实践了很多,例如下面的博客,但是几乎都是非常的繁琐, 冗余呀!

 

https://blog.csdn.net/sinat_27639721/article/details/73104843

类似的博客大同小异,很多都是互相的抄袭,实践了好几个,很多博文都是缺少东西.

感觉自己收获甚少, 最后通过大米时代师兄弟妹们互相交流,最后研究成功,并且过程其实非常的简单:

 

2, 大米时代方案:

 

 

你没有看错,就只需该两个地方就成了.

(1) Springmvc的配置文件里添加

<bean class="springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration" id="swagger2Config"/>
<mvc:resources location="classpath:/META-INF/resources/" mapping="swagger-ui.html"/>
<mvc:resources location="classpath:/META-INF/resources/webjars/" mapping="/webjars/**"/>

 


(2)web工程中的pom文件中添加

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




随便一个出来结果如下:



 

 

如果需要注明返回方式,还需在Controller 中写明请求的方式:是 get/put/post等方式即可例如下:


 

 

四,总结


       学习是如此的有趣,快乐,谢谢我的师傅,谢谢当年引导我学习成长的导师,现在的感受是越来越有意思,学习越来越有趣, 让尽可能的每天让自己有进步, 有记录有成长的足迹.

     谢谢您的阅读, 愿和大家一同交流学习,共同进步和成长.

 


这篇关于项目配置swagger(亲测能用)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1112853

相关文章

深度解析Java项目中包和包之间的联系

《深度解析Java项目中包和包之间的联系》文章浏览阅读850次,点赞13次,收藏8次。本文详细介绍了Java分层架构中的几个关键包:DTO、Controller、Service和Mapper。_jav... 目录前言一、各大包1.DTO1.1、DTO的核心用途1.2. DTO与实体类(Entity)的区别1

Linux中SSH服务配置的全面指南

《Linux中SSH服务配置的全面指南》作为网络安全工程师,SSH(SecureShell)服务的安全配置是我们日常工作中不可忽视的重要环节,本文将从基础配置到高级安全加固,全面解析SSH服务的各项参... 目录概述基础配置详解端口与监听设置主机密钥配置认证机制强化禁用密码认证禁止root直接登录实现双因素

嵌入式数据库SQLite 3配置使用讲解

《嵌入式数据库SQLite3配置使用讲解》本文强调嵌入式项目中SQLite3数据库的重要性,因其零配置、轻量级、跨平台及事务处理特性,可保障数据溯源与责任明确,详细讲解安装配置、基础语法及SQLit... 目录0、惨痛教训1、SQLite3环境配置(1)、下载安装SQLite库(2)、解压下载的文件(3)、

如何在Spring Boot项目中集成MQTT协议

《如何在SpringBoot项目中集成MQTT协议》本文介绍在SpringBoot中集成MQTT的步骤,包括安装Broker、添加EclipsePaho依赖、配置连接参数、实现消息发布订阅、测试接口... 目录1. 准备工作2. 引入依赖3. 配置MQTT连接4. 创建MQTT配置类5. 实现消息发布与订阅

springboot项目打jar制作成镜像并指定配置文件位置方式

《springboot项目打jar制作成镜像并指定配置文件位置方式》:本文主要介绍springboot项目打jar制作成镜像并指定配置文件位置方式,具有很好的参考价值,希望对大家有所帮助,如有错误... 目录一、上传jar到服务器二、编写dockerfile三、新建对应配置文件所存放的数据卷目录四、将配置文

Linux如何快速检查服务器的硬件配置和性能指标

《Linux如何快速检查服务器的硬件配置和性能指标》在运维和开发工作中,我们经常需要快速检查Linux服务器的硬件配置和性能指标,本文将以CentOS为例,介绍如何通过命令行快速获取这些关键信息,... 目录引言一、查询CPU核心数编程(几C?)1. 使用 nproc(最简单)2. 使用 lscpu(详细信

怎么用idea创建一个SpringBoot项目

《怎么用idea创建一个SpringBoot项目》本文介绍了在IDEA中创建SpringBoot项目的步骤,包括环境准备(JDK1.8+、Maven3.2.5+)、使用SpringInitializr... 目录如何在idea中创建一个SpringBoot项目环境准备1.1打开IDEA,点击New新建一个项

Nginx 重写与重定向配置方法

《Nginx重写与重定向配置方法》Nginx重写与重定向区别:重写修改路径(客户端无感知),重定向跳转新URL(客户端感知),try_files检查文件/目录存在性,return301直接返回永久重... 目录一.try_files指令二.return指令三.rewrite指令区分重写与重定向重写: 请求

Nginx 配置跨域的实现及常见问题解决

《Nginx配置跨域的实现及常见问题解决》本文主要介绍了Nginx配置跨域的实现及常见问题解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来... 目录1. 跨域1.1 同源策略1.2 跨域资源共享(CORS)2. Nginx 配置跨域的场景2.1

gitlab安装及邮箱配置和常用使用方式

《gitlab安装及邮箱配置和常用使用方式》:本文主要介绍gitlab安装及邮箱配置和常用使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1.安装GitLab2.配置GitLab邮件服务3.GitLab的账号注册邮箱验证及其分组4.gitlab分支和标签的