SpringBoot中优雅的使用Swag

北京治疗白癜风哪家医院好啊 http://m.39.net/pf/bdfyy/bjzkbdfyy/

SpringBoot中优雅的使用Swagger2-

前言

SpringBoot框架是目前非常流行的微服务框架,我们很多情况下使用它来提供RestAPI。而对于RestAPI来说很重要的一部分内容就是文档,Swagger为我们提供了一套通过代码和注解自动生成文档的方法,这一点对于保证API文档的及时性将有很大的帮助。本文将使用Swagger2规范的Springfox实现来了解如何在SpringBoot项目中使用Swagger,主要包含了如何使用Swagger自动生成文档、使用Swagger文档以及Swagger相关的一些高级配置和注解。

Swagger简介

Swagger是一套基于OpenAPI规范构建的开源工具,可以帮助我们设计、构建、记录以及使用RestAPI。Swagger主要包含了以下三个部分:

SwaggerEditor:基于浏览器的编辑器,我们可以使用它编写我们OpenAPI规范。

SwaggerUI:它会将我们编写的OpenAPI规范呈现为交互式的API文档,后文我将使用浏览器来查看并且操作我们的RestAPI。

SwaggerCodegen:它可以通过为OpenAPI(以前称为Swagger)规范定义的任何API生成服务器存根和客户端SDK来简化构建过程。

为什么要使用Swagger

当下很多公司都采取前后端分离的开发模式,前端和后端的工作由不同的工程师完成。在这种开发模式下,维持一份及时更新且完整的RestAPI文档将会极大的提高我们的工作效率。传统意义上的文档都是后端开发人员手动编写的,相信大家也都知道这种方式很难保证文档的及时性,这种文档久而久之也就会失去其参考意义,反而还会加大我们的沟通成本。而Swagger给我们提供了一个全新的维护API文档的方式,下面我们就来了解一下它的优点:

代码变,文档变。只需要少量的注解,Swagger就可以根据代码自动生成API文档,很好的保证了文档的时效性。

跨语言性,支持40多种语言。

SwaggerUI呈现出来的是一份可交互式的API文档,我们可以直接在文档页面尝试API的调用,省去了准备复杂的调用参数的过程。

还可以将文档规范导入相关的工具(例如SoapUI),这些工具将会为我们自动地创建自动化测试。以上这些优点足以说明我们为什么要使用Swagger了,您是否已经对Swagger产生了浓厚的兴趣了呢?下面我们就将一步一步地在SpringBoot项目中集成和使用Swagger,让我们从准备一个SpringBoot的Web项目开始吧。

SpringBoot整合Swagger2

SpringBoot整合Swagger2-前期准备

首先创建一个基础的SpringBootweb项目。您可以通过SpringInitializr页面生成一个空的SpringBoot项目,或者通过idea创建一个SpringBoot项目

添加依赖

##1.`SpringBoot的Web依赖`dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-web/artifactId/dependency

##2.集成swagger2dependencygroupIdio.springfox/groupIdartifactIdspringfox-swagger2/artifactIdversion2.9.2/version/dependency

##3.`集成SwaggerUI`dependencygroupIdio.springfox/groupIdartifactIdspringfox-swagger-ui/artifactIdversion2.9.2/version/dependency

SpringBoot整合Swagger2-核心在这里插入代码片代码编写

java中Swagger2配置-直接上配置代码,Swagger2的配置是比较容易的,在成功项目创建之后,只需要开发者自己提供一个Docket的Bean.(注释写的很清楚,这里就不一一解释了。不懂的地方可以在片尾


转载请注明:http://www.aierlanlan.com/cyrz/4657.html