全网整合营销服务商

电脑端+手机端+微信端=数据同步管理

免费咨询热线:400-708-3566

SpringMVC和Swagger整合方法

描述

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码,允许 API 来始终保持同步。Swagger 让部署管理和使用功能强大的 API 从未如此简单。

配置

1、引入相关jar包:

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

2、创建java配置类

@Configuration
@EnableSwagger2
public class Swagger2 {
  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
         // 文档标题
        .title("wish")
        // 文档描述
        .description("https://github.com/handexing").termsOfServiceUrl("https://github.com/handexing")
        .version("v1")
        .build();
  }
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        // 指定controller存放的目录路径
        .apis(RequestHandlerSelectors.basePackage("com.wish.controller"))
        .paths(PathSelectors.any())
        .build();
  }
}

3、编写接口文档测试

@RequestMapping(value = "testSawgger", method = RequestMethod.POST, produces = "application/json; charset=utf-8")
@ApiOperation(value = "测试swagger", httpMethod = "POST", notes = "testSawgger")
public ExecuteResult<Boolean> addUser(@ApiParam(value = "参数", required = true) Long id) {
  ExecuteResult<Boolean> result = new ExecuteResult<Boolean>();
  try {
    result.setSuccess(true);
  } catch (Exception e) {
    result.setSuccess(false);
  }
  return result;
}

说明:

@ApiOperation:用在方法之上

1、value: 表示接口名称

2、notes: 表示接口详细描述

3、httpMethod:表示接口请求方法类型

@ApiParam:用在方法参数上

1、required:表示参数是否必须传

2、name:表示参数名称

3、value:表示参数描述

测试

swagger2文档的默认地址是 /swagger-ui.html, 本地开发的访问http://localhost:8080/swagger-ui.html就可以看到自动生成的文档了

结语

到这就配置好了,最终demo可查看 源码地址

总结

以上所述是小编给大家介绍的SpringMVC和Swagger整合方法,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对网站的支持!


# springmvc整合swagger  # swagger和springmvc  # springMVC利用FastJson接口返回json数据相关配置详解  # springmvc fastjson 反序列化时间格式化方法(推荐)  # 详解在springmvc中解决FastJson循环引用的问题  # Spring MVC集成springfox-swagger2构建restful API的方法详解  # SpringMVC集成Swagger实例代码  # Spring MVC利用Swagger2如何构建动态RESTful API详解  # SpringMVC如何在生产环境禁用Swagger的方法  # SpringMVC 中配置 Swagger 插件的教程(分享)  # Spring MVC+FastJson+Swagger集成的完整实例教程  # 文档  # 用在  # 小编  # 是一个  # 好了  # 在此  # 这就  # 给大家  # 所述  # 文件系统  # 给我留言  # 始终保持  # 自动生成  # 感谢大家  # 就可以  # 客户端  # 疑问请  # 有任何  # private  # ApiInfo 


相关文章: 邀请函制作网站有哪些,有没有做年会邀请函的网站啊?在线制作,模板很多的那种?  平台云上自主建站:模板化设计与智能工具打造高效网站  电影网站制作价格表,那些提供免费电影的网站,他们是怎么盈利的?  制作营销网站公司,淘特是干什么用的?  JS中使用new Date(str)创建时间对象不兼容firefox和ie的解决方法(两种)  如何在阿里云购买域名并搭建网站?  建站ABC备案流程中有哪些关键注意事项?  专业企业网站设计制作公司,如何理解商贸企业的统一配送和分销网络建设?  网站广告牌制作方法,街上的广告牌,横幅,用PS还是其他软件做的?  一键网站制作软件,义乌购一件代发流程?  高性能网站服务器部署指南:稳定运行与安全配置优化方案  网站网页制作电话怎么打,怎样安装和使用钉钉软件免费打电话?  香港服务器网站搭建教程-电商部署、配置优化与安全稳定指南  手机网站制作平台,手机靓号代理商怎么制作属于自己的手机靓号网站?  教育培训网站制作流程,请问edu教育网站的域名怎么申请?  建站主机CVM配置优化、SEO策略与性能提升指南  如何在搬瓦工VPS快速搭建网站?  javascript中的try catch异常捕获机制用法分析  如何用景安虚拟主机手机版绑定域名建站?  东莞市网站制作公司有哪些,东莞找工作用什么网站好?  建站主机是否等同于虚拟主机?  如何用低价快速搭建高质量网站?  宠物网站制作html代码,有没有专门介绍宠物如何养的网站啊?  ppt制作免费网站有哪些,ppt模板免费下载网站?  如何快速生成凡客建站的专业级图册?  视频网站制作教程,怎么样制作优酷网的小视频?  建站主机服务器选购指南:轻量应用与VPS配置解析  如何在IIS7中新建站点?详细步骤解析  定制建站哪家更专业可靠?推荐榜单揭晓  黑客入侵网站服务器的常见手法有哪些?  北京制作网站的公司,北京铁路集团官方网站?  大连 网站制作,大连天途有线官网?  营销式网站制作方案,销售哪个网站招聘效果最好?  建站之星如何快速更换网站模板?  javascript基本数据类型及类型检测常用方法小结  如何用花生壳三步快速搭建专属网站?  如何在西部数码注册域名并快速搭建网站?  Bpmn 2.0的XML文件怎么画流程图  如何在IIS中新建站点并配置端口与物理路径?  详解免费开源的DotNet二维码操作组件ThoughtWorks.QRCode(.NET组件介绍之四)  如何快速查询网站的真实建站时间?  成都网站制作报价公司,成都工业用气开户费用?  h5网站制作工具有哪些,h5页面制作工具有哪些?  如何在腾讯云服务器快速搭建个人网站?  哈尔滨网站建设策划,哈尔滨电工证查询网站?  c++怎么使用类型萃取type_traits_c++ 模板元编程类型判断【方法】  专业型网站制作公司有哪些,我设计专业的,谁给推荐几个设计师兼职类的网站?  网站制作大概多少钱一个,做一个平台网站大概多少钱?  如何选择可靠的免备案建站服务器?  北京网站制作公司哪家好一点,北京租房网站有哪些? 

您的项目需求

*请认真填写需求信息,我们会在24小时内与您取得联系。