项目配置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

相关文章

SpringBoot日志配置SLF4J和Logback的方法实现

《SpringBoot日志配置SLF4J和Logback的方法实现》日志记录是不可或缺的一部分,本文主要介绍了SpringBoot日志配置SLF4J和Logback的方法实现,文中通过示例代码介绍的非... 目录一、前言二、案例一:初识日志三、案例二:使用Lombok输出日志四、案例三:配置Logback一

springboot security之前后端分离配置方式

《springbootsecurity之前后端分离配置方式》:本文主要介绍springbootsecurity之前后端分离配置方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的... 目录前言自定义配置认证失败自定义处理登录相关接口匿名访问前置文章总结前言spring boot secu

一文详解SpringBoot响应压缩功能的配置与优化

《一文详解SpringBoot响应压缩功能的配置与优化》SpringBoot的响应压缩功能基于智能协商机制,需同时满足很多条件,本文主要为大家详细介绍了SpringBoot响应压缩功能的配置与优化,需... 目录一、核心工作机制1.1 自动协商触发条件1.2 压缩处理流程二、配置方案详解2.1 基础YAML

springboot简单集成Security配置的教程

《springboot简单集成Security配置的教程》:本文主要介绍springboot简单集成Security配置的教程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,... 目录集成Security安全框架引入依赖编写配置类WebSecurityConfig(自定义资源权限规则

SpringBoot中封装Cors自动配置方式

《SpringBoot中封装Cors自动配置方式》:本文主要介绍SpringBoot中封装Cors自动配置方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录SpringBoot封装Cors自动配置背景实现步骤1. 创建 GlobalCorsProperties

一文教你如何将maven项目转成web项目

《一文教你如何将maven项目转成web项目》在软件开发过程中,有时我们需要将一个普通的Maven项目转换为Web项目,以便能够部署到Web容器中运行,本文将详细介绍如何通过简单的步骤完成这一转换过程... 目录准备工作步骤一:修改​​pom.XML​​1.1 添加​​packaging​​标签1.2 添加

Spring Boot结成MyBatis-Plus最全配置指南

《SpringBoot结成MyBatis-Plus最全配置指南》本文主要介绍了SpringBoot结成MyBatis-Plus最全配置指南,包括依赖引入、配置数据源、Mapper扫描、基本CRUD操... 目录前言详细操作一.创建项目并引入相关依赖二.配置数据源信息三.编写相关代码查zsRArly询数据库数

tomcat多实例部署的项目实践

《tomcat多实例部署的项目实践》Tomcat多实例是指在一台设备上运行多个Tomcat服务,这些Tomcat相互独立,本文主要介绍了tomcat多实例部署的项目实践,具有一定的参考价值,感兴趣的可... 目录1.创建项目目录,测试文China编程件2js.创建实例的安装目录3.准备实例的配置文件4.编辑实例的

SpringBoot配置Ollama实现本地部署DeepSeek

《SpringBoot配置Ollama实现本地部署DeepSeek》本文主要介绍了在本地环境中使用Ollama配置DeepSeek模型,并在IntelliJIDEA中创建一个Sprin... 目录前言详细步骤一、本地配置DeepSeek二、SpringBoot项目调用本地DeepSeek前言随着人工智能技

如何自定义Nginx JSON日志格式配置

《如何自定义NginxJSON日志格式配置》Nginx作为最流行的Web服务器之一,其灵活的日志配置能力允许我们根据需求定制日志格式,本文将详细介绍如何配置Nginx以JSON格式记录访问日志,这种... 目录前言为什么选择jsON格式日志?配置步骤详解1. 安装Nginx服务2. 自定义JSON日志格式各