SpringBoot和Swagger结合提高API开发效率
作者：henryzhu007 发布时间：2023-11-25 01:23:16
标签：spring,boot,swagger
现在Web开发越来越倾向于前后端分离，前端使用AngularJS，React，Vue等，部署在NodeJS上，后面采用SpringBoot发布Rest服务，前后端进行分离。这样的架构灵活且特别适合大型团队的协作开发。 那么问题来了，因为前端都是和后端通过API进行交互的，那么前后端的Rest API的接口如何进行定义和沟通呢？首先想到的应该就是Swagger。
那么什么是Swagger，Swagger™的目标是为REST APIs 定义一个标准的，与语言无关的接口，使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能。当服务通过Swagger定义，消费者就能与远程的服务互动通过少量的实现逻辑。类似于低级编程接口，Swagger去掉了调用服务时的很多猜测。 浏览 Swagger-Spec 去了解更多关于Swagger 项目的信息，包括附加的支持其他语言的库。
那么在SpringBoot中，如何和Swagger进行集成呢？其实非常的简单，只需要把
下面的依赖添加到Maven项目的pom.xml文件中，就可以了。SpringBoot就会自动应用Swagger，并生成相应的接口。
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
<scope>compile</scope>
</dependency>
当SpringBoot启动以后，直接在网站后面加上swagger-ui.html就能访问，具体见下图，也太神奇了。
总结
以上所述是小编给大家介绍的SpringBoot和Swagger结合提高API开发效率，希望对大家有所帮助。
来源：http://blog.csdn.net/chancein007/article/details/78118259
0
投稿猜你喜欢
在一个完整的项目中，如果每一个控制器的方法都返回不同的结果，那么对项目的维护和扩展都会很麻烦；并且现在主流的开发模式时前后端分离的模式，如果- 前言先说缓存，合理使用缓存是优化中最常见的，将从数据库中查询出来的数据放入缓存中，下次使用时不必从数据库查询，而是直接从缓存中读取，避免频繁
- 怎么使用异步，就是用委托进行处理，如果委托对象在调用列表中只有一个方法，它就可以异步执行这个方法。委托类有两个方法
- 背景前段时间同事碰到一个问题，需要在 SpringCloud 的 Feign 调用中使用自定义的 URL；通常情况下是没有这个需求的；毕竟都
- springmvc提供了 * ，类似于过滤器，他将在我们的请求具体出来之前先做检查，有权决定接下来是否继续，对我们的请求进行加工。 * ，可
- 本文详细讲述了Android平台基于Pull方式对XML文件解析与写入方法。分享给大家供大家参考，具体如下：XML技术在跨平台的情况下的数据
- 本文实例为大家分享了好看的android音量旋钮，供大家参考，具体内容如下效果图：实现思路，用的自定义的控件,图片和按钮都是自己绘制的，并且
- 先来说一说我们为什么要用这个东西啊！比如，我们现在有这样了个问题要解决：这样，我们就要用到中间消息间了然后我们就说一下什么是中间消息间吧。采
- 前言对于页面携带的请求头中的AcceptSpringBoot有对应的10种MessageConvert可以支持写出对应的媒体类型，比如app
- 本章讲述：FileStream类的基本功能，以及简单示例；1、引用命名空间：using System.IO;2、注意：使用IO操作文件时，要
- 效果自定义密码输入框，项目的一个界面需求，我把这个自定义的输入框提取出来作为这次内容的题目。输入前: 输入后： 输入1个
- 什么是JMX？什么是JMX,Java Management Extensions，即Java管理扩展，是一个为应用程序、设备、系统等植入管理
- SpringBoot使用protobuf格式的接口建立SpringBoot项目，pom.xml内容如下：<?xml version=&
- 本文实例讲解了统计文本中某个字符串出现的次数或字符串中指定元素出现的次数方法，分享给大家供大家参考，具体内容如下运行效果图：程序查找的上此文
- 本文实例为大家分享了C#实现飞行棋小游戏的具体代码，供大家参考，具体内容如下逻辑图 以下是掷色子的一个代码，比较有代表性，里面的逻
- 一、自动装配1、四种类型的自动装配类型解释xml 配置byName根据 Bean 的 name 或者 id<bean id=”bean
- 本人使用Android开发有一段时间了，但是本身没有系统学，而且多年专注服务端开发，总觉得因为项目需要接触Android移动端开发只是暂时的
- 业务场景我们知道在使用PageHelper分页插件时，会对执行PageHelper.startPage(pageNum, pageSize)
- 1. 概述官方JavaDocsApi: javax.swing.JFrameJFrame，窗口。JFrame 是一个可以独立显示的组件，一个
- C# 中的委托（Delegate）类似于 C 或 C++ 中函数的指针。委托（Delegate） 是存有对某个方法的引用的一种引用类型变量。
