[聚合文章] Spring boot优雅的整合Swagger

软件架构 2017-12-19 21 阅读

一、简介

运用 Spring boot 搭建项目简单快捷,但在我们开发中,还有一个问题,是必须且让人感到头疼,那就是前后端代码联调,有时很难断定问题是出在哪个环节,而 Swagger 则解决了这个繁杂的问题,对于前后端开发人员来说,只需要定义好接口传输需要的参数类型与格式,通过Swagger直接调试接口,如果能够返回正确的预期结构,则对于后端开发人员来说,不再需要关注该问题,而对于前端开发人员来说,只需要连接后端提供的Swagger服务器查看接口参数类型格式,以及返回类型是否为自己想要的,而专心的做自己的任务开发,从而在工作中降低了沟通成本,在很大程度上提高了工作效率。

1、Spring boot

Spring Boot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置,从而使开发人员不再需要定义样板化的配置。通过这种方式,Boot致力于在蓬勃发展的快速应用开发领域

1、特点

  • 创建独立的Spring应用程序
  • 嵌入的Tomcat,无需部署WAR文件
  • 简化Maven配置
  • 自动配置Spring
  • 提供生产就绪型功能,如指标,健康检查和外部配置
  • 绝对没有代码生成和对XML没有要求配置

2、优点

  • spring boot 可以支持你快速的开发出restful 风格微服务架构
  • 自动化确实方便,做微服务再合适不过了,单一jar包部署和管理都非常方便。只要系统架构设计合理,大型项目也能用,加上nginx负载均衡,轻松实现横向扩展
  • spring boot 要解决的问题, 精简配置是一方面, 另外一方面是方便的让spring生态圈和其他工具链整合(比如redis, email, elasticsearch)
  • 一键启动,不需要配置服务器(如:tomcat等)。

2、Swagger

  • Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。本文简单介绍了在项目中集成swagger的方法和一些常见问题。如果想深入分析项目源码,了解更多内容,见参考资料。
  • Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。

注:本文内容来自互联网,旨在为开发者提供分享、交流的平台。如有涉及文章版权等事宜,请你联系站长进行处理。