iis服务器助手广告广告
返回顶部
首页 > 资讯 > 后端开发 > Python >关于使用swagger整合springMVC的方法
  • 582
分享到

关于使用swagger整合springMVC的方法

swagger整合swaggerspringMVC 2023-05-17 20:05:36 582人浏览 泡泡鱼

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

摘要

目录前文:swagger原理前台配置:Maven依赖:后台配置:途径一:途径二:前文: 在日常工作中,开发人员经常会遇到写接口文档的工作,一般都是Word文档,带来书写麻烦、维护麻烦

前文:

在日常工作中,开发人员经常会遇到写接口文档的工作,一般都是Word文档,带来书写麻烦、维护麻烦的问题,比如改了源代码忘了更新文档、解释不明确带来歧义、无法在线尝试等等。swagger就是为了解决这些问题而产生的。这是官方的例子,截图如下

swagger原理

后台:后端部分与java集成,后最终会产生一个JSON文件。

前台:前台部分就是htmlCSSjs文件,js利用后台产生的json文件构造api

前台配置:

https://GitHub.com/swagger-api/swagger-ui 下载zip包,解压后,将dist文件夹下的所有内容copy到,JAVA WEB project的WEBapp下,比如,

maven依赖:

<repositories>
    <repository>
      <id>jcenter-release</id>
      <name>jcenter</name>
      <url>Http://oss.jfrog.org/artifactory/oss-release-local/</url>
    </repository>
</repositories>
 
<dependency>
    <groupId>com.manGofactory</groupId>
    <artifactId>swagger-springMVC</artifactId>
    <version>1.0.1</version>
</dependency>

后台配置:

途径一:

spring的applicationcontext.xml文件中,添加配置

 <mvc:annotation-driven/>
    <bean class="com.mangofactory.swagger.configuration.SpringSwaggerConfig" />
    <!-- 对包中的所有类进行扫描,以完成Bean创建和自动依赖注入的功能 稍后会创建该包:webmvct.cmd -->    
	<context:component-scan base-package="webmvct.cmd"/>

解释:swagger会扫描 base-package包下的所有类,生成api文档

将docapi文件下的index.html文件,url改为本工程的路径,如下图,

截止到现在,最简单的swagger配置已经完成。访问 //localhost:8080/hi/docapi/index.html 就可以看到效果。

途径二:

如果想进一步的定制,比如只扫描某个包下的某些路径,那么就需要用到定制类,途径二是基于途径一在功能上的扩展,所以要想达到定制效果首先将途径一配置好。

创建swaggersprinGConfig定制类,比如

@Configuration
@EnableSwagger //Loads the spring beans required by the framework
@ComponentScan("com.test")
public class MySwaggerConfig {
	private SpringSwaggerConfig springSwaggerConfig;
 
	   
	   @Autowired
	   public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig) {
	      this.springSwaggerConfig = springSwaggerConfig;
	   }
 
	   
	   @Bean
	   public SwaggerSpringMvcPlugin customImplementation(){
	      return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
	      .includePatterns(".*store.*");
	      
	   }
 
}

@componentscan,将com.test包下的类也包含在内进行扫描;

customImplementation方法的includePatterns可以进行过滤,只include含有store的路径

controller类的样例:

@Api(value="/store",description="商店")
@Controller
@RequestMapping("/store")
public class StoreController {
	
	
	@RequestMapping(value = "/{storeid}",method=RequestMethod.GET)
	@ResponseBody
	@ApiOperation(value="获取商店信息",notes="通过商店id获取商店信息")
	public Store getStore(String storeid){
		return new Store();
	}
	
	@ApiOperation(value="获取商店信息",notes="通过商店name获取商店信息")
	@ResponseBody
	@RequestMapping(value = "/{storename}",method=RequestMethod.POST)
	public Store getStore2(String storeid){
		return new Store();
	}
}

@api,用在类上,用于解释整个类。

@apioperation,用于方法上,value是笼统的介绍方法作用,notes是详细的说明方法作用

最终效果图:

以上配置参考:

swagger整合spring mvc的doc点击打开链接

swagger注解说明 点击打开链接

到此这篇关于关于使用swagger整合springMVC的方法的文章就介绍到这了,更多相关swagger整合springMVC内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

--结束END--

本文标题: 关于使用swagger整合springMVC的方法

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

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

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

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

下载Word文档
猜你喜欢
  • 关于使用swagger整合springMVC的方法
    目录前文:swagger原理前台配置:maven依赖:后台配置:途径一:途径二:前文: 在日常工作中,开发人员经常会遇到写接口文档的工作,一般都是word文档,带来书写麻烦、维护麻烦...
    99+
    2023-05-17
    swagger整合 swagger springMVC
  • 关于springboot整合swagger问题及解决方法
    目录一.前言二.整合jsp1.pom引入2.配置文件application.properties3.前端代码目录4.运行效果 三.整合swagger1.pom引入2.swa...
    99+
    2024-04-02
  • 使用SpringMVC怎么对Swagger进行整合
    这篇文章将为大家详细讲解有关使用SpringMVC怎么对Swagger进行整合,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。配置引入相关jar包:<dependency>&nbs...
    99+
    2023-05-31
    springmvc swagger
  • SpringBoot整合Swagger的方法是什么
    本文小编为大家详细介绍“SpringBoot整合Swagger的方法是什么”,内容详细,步骤清晰,细节处理妥当,希望这篇“SpringBoot整合Swagger的方法是什么”文章能帮助大家解决疑惑,下面跟着小编的思路慢慢深入,一起来学习新知...
    99+
    2023-07-06
  • 详谈Springfox与swagger的整合使用
    一、前言让我们先理一下springfox与swagger的关系。swagger是一个流行的API开发框架,这个框架以“开放API声明”(OpenAPI Specification,OAS)为基础,对整个API的开发周期都提供了相应的解决方案...
    99+
    2023-05-31
    springfox swagger fo
  • SpringMVC整合Kaptcha的具体使用
    目录验证码的作用Kaptcha 简介Kaptcha 详细配置表Spring MVC 整合 KaptchaPOM创建 Spring 配置控制器关键代码JSP 关键代码验证码的作用 防止...
    99+
    2024-04-02
  • 关于Swagger注释API的使用说明
    目录API详细说明示例@ApiImplicitParamparamType 示例详解接收对象传参的例子API详细说明 注释汇总 作用范围API使用位置对象属性@ApiModelPro...
    99+
    2024-04-02
  • 使用SpringMVC如何实现整合mybatis
    这篇文章给大家介绍使用SpringMVC如何实现整合mybatis,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache softw...
    99+
    2023-05-31
    springmvc mybatis
  • 关于TransparentBlt的使用方法
    TransparentBlt是GDI函数之一,用于在Windows平台上绘制透明图像。它可以将源图像的一部分或全部绘制到目标设备上,...
    99+
    2023-08-08
    TransparentBlt
  • 关于spring boot整合kafka+注解方式
    目录spring boot自动配置方式整合spring boot自动配置的不足spring boot下手动配置kafka批量消费消息spring boot整合kafka报错sprin...
    99+
    2024-04-02
  • 关于springboot2整合lettuce启动卡住问题的解决方法
    前言 EasyCache升级兼容 Springboot2,有个业务系统启动总是会卡住,最后抛出超时异常,如下: java.util.concurrent.TimeoutExcep...
    99+
    2024-04-02
  • SpringBoot整合接口管理工具Swagger怎么使用
    这篇“SpringBoot整合接口管理工具Swagger怎么使用”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家阅读完这篇文章能有所收获,下面我们一起来看看这篇“SpringB...
    99+
    2023-07-06
  • 关于JavaScript的URL.createObjectURL()的使用方法
    URL.createObjectURL() 静态方法会创建一个 DOMString,其中包含一个表示参数中给出的对象的URL。这个 URL 的生命周期和创建它的窗口中的 docume...
    99+
    2023-05-17
    JavaScript createObjectURL() URL.createObjectURL()
  • 关于SpringMVC在Controller层方法的参数解析详解
    目录自定义参数解析器实现效果实现和配置Spring提供解析器一些使用Tricky总结使用版本: spring-boot: 2.1.6.RELEASE sping: 5.1.8.RE...
    99+
    2024-04-02
  • 关于python DataFrame的合并方法总结
    目录python DataFrame的合并方法#concat函数#merge函数#append函数把两个dataframe合并成一个python DataFrame的合并方法 Pyt...
    99+
    2024-04-02
  • JavaHibernate使用方法及整合查询
    目录Hibernate的使用Spring整合Hibernate自定义查询多表关系实现提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档 Jpa是满足JavaEE开发的标...
    99+
    2023-05-14
    Java Hibernate Java Hibernate使用
  • springcloud整合openfeign使用的方法是什么
    这篇文章主要介绍“springcloud整合openfeign使用的方法是什么”,在日常操作中,相信很多人在springcloud整合openfeign使用的方法是什么问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家...
    99+
    2023-07-05
  • SQL中关于distinct关键字的使用方法
    这篇文章主要介绍SQL中关于distinct关键字的使用方法,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们一定要看完!在使用mysql时,有时需要查询出某个字段不重复的记录,虽然mysql提供有...
    99+
    2024-04-02
  • 关于SpringBoot整合redis使用Lettuce客户端超时问题
    参考的博客 问题起因 做毕设的时候,使用到Lettuce连接redis,一段时间后不操作,再去操作redis,会报连接超时错误,在其重连后又可使用。 原因是:Lettuce 自适应拓...
    99+
    2024-04-02
  • SpringBoot中使用Swagger的超简单方法
    Swagger号称世界上最流行的Api框架,它是RestFul 风格的Api。文档在线自动生成工具:Api文档与API定义同步更新。可以直接运行,能在线测试API接口;支持多种编程语...
    99+
    2024-04-02
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作