前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >SpringBoot2.x系列教程(四十三)SpringBoot整合Swagger2

SpringBoot2.x系列教程(四十三)SpringBoot整合Swagger2

作者头像
程序新视界
发布2020-03-18 17:24:28
6780
发布2020-03-18 17:24:28
举报
文章被收录于专栏:丑胖侠丑胖侠丑胖侠

在上篇文章中我们讲解了RESTful的概念及相关风格API的设计,那么针对多客户端的API,作为后端开发如何对接口进行验证呢?当然,可以通过写单元测试来完成。但如果还需要维护每个接口的API文档,同时还要保持版本更新维护呢?是不是工作量变得异常繁重了。

那么,Swagger的出现,可以帮助后端开发人员轻松的解决上述痛点。

针对接口的功能测试,你不仅可以通过单元测试来进行验证,还可以通过Swagger提供的可视化页面操作来进行操作完成。

针对API文档,通过Swagger提供的功能,可以系统的管理整个项目的API文档。

而Swagger又可以轻松整合到Spring Boot等项目中,与Spring MVC程序配合组织出强大RESTful API文档。

减少创建文档的繁琐操作,接口描述又整合入代码中,让维护文档和修改代码整合为一体。实现了在修改代码逻辑的同时轻松修改接口文档说明。

不仅如此,针对每个接口在页面上还提供了强大的测试功能,可以针对每一个接口进行测试操作。

效果及示例页面如下:

image
image

Spring Boot集成Swagger2

在Spring Boot中集成Swagger2是非常方便,特别是使用最新版本的Swagger2,只用添加依赖,配置实例化类,即可完成最简单的接口及API文档的呈现和使用。

引入依赖

这里引入当前最新版本的Swagger2的依赖:

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger
本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • Spring Boot集成Swagger2
    • 引入依赖
    相关产品与服务
    Serverless HTTP 服务
    Serverless HTTP 服务基于腾讯云 API 网关 和 Web Cloud Function(以下简称“Web Function”)建站云函数(云函数的一种类型)的产品能力,可以支持各种类型的 HTTP 服务开发,实现了 Serverless 与 Web 服务最优雅的结合。用户可以快速构建 Web 原生框架,把本地的 Express、Koa、Nextjs、Nuxtjs 等框架项目快速迁移到云端,同时也支持 Wordpress、Discuz Q 等现有应用模版一键快速创建。
    领券
    问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档