如何在 swgger 中设置连接前后端的 API 接口

2023-11-19

在的网站大多都是前后端分离式的开发,前后端都衍生出了自己的框架。现在前后端交互的唯一方式就是 API 接口。

曾经前后端交互都需要后端人员手动编写 API 接口文档,规定路径、请求方式、返回类型,这样效率很低。

swagger 就是更好地书写 API 文档的框架。

二、swagger 介绍

swagger 可以根据后台接口自动生成可视化的 restful 风格的 API 文档,并可以进行 API 测试(发送各种请求,测试接口)

1、前端人员不用再去理解后端代码,后端人员也不用专门编写接口文档。2、swagger 直接自动生成可供测试、可视化的 API 文档,前端人员在不知道后端代码的情况下,也能根据 swagger 提供的 API 文档理解每个接口的作用,并可以测试接口是否能够正常使用。

三、在 maven+springboot 项目中使用 swagger

1.首先在 pom.xml 中导入依赖

 springfox-swagger2 是 swagger 的 java 实现 springfox-swagger-ui 是网页上显示 swagger 文档的 jar 包

<!--swagger jar包-->   <dependency>       <groupId>io.springfox</groupId>       <artifactId>springfox-swagger2</artifactId>       <version>2.8.0</version>   </dependency>   <dependency>      <groupId>io.springfox</groupId>      <artifactId>springfox-swagger-ui</artifactId>      <version>2.8.0</version>   </dependency><!--swagger jar包-->复制代码

复制代码

2.编写 swagger 配置文件 

创建一个 config 文件夹,在文件夹里创建 SwaggerConfig.java 文件作为我们的 swagger 配置文件。

import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.ComponentScan;import org.springframework.context.annotation.Configuration;import org.springframework.web.servlet.config.annotation.EnableWebMvc;import springfox.documentation.builders.ApiInfoBuilder;import springfox.documentation.builders.PathSelectors;import springfox.documentation.builders.RequestHandlerSelectors;import spr
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

如何在 swgger 中设置连接前后端的 API 接口 的相关文章

  • 使用 TreeMap 和 Comparator 按值对 HashMap 进行排序

    我使用以下代码创建哈希图 然后使用树形图和比较器对哈希图中的值进行排序 然而 输出结果却出乎意料 所以任何关于我做错了什么的想法都会有帮助 Code public static void main String args System ou
  • 使用 Nginx 时缺少 HTTP 状态代码名称

    我正在使用 Nginx 将所有 HTTP 请求重定向到 HTTPS 在我的 Spring Boot 应用程序中 这是我正在使用的 nginx 配置 通过它我可以将所有请求重定向到 Https 但是当我这样做时 我得到了状态码返回正确 但没有
  • 通过 JDBC 连接到 DB2 时的用户和密码

    我正在尝试连接到本地 DB2 10 5 Express C 服务器 这是一个测试环境 所以我不关心安全性 我能够连接到命令行处理器 在 Windows 上运行 并且我更改了配置设置AUTHENTICATION CLIENT and TRUS
  • 如何避免 Java 中的忙旋转

    我有一个多线程应用程序 其中一个线程向另一个线程发送消息 等待线程轮询消息并做出反应 处理锁 像这样 等待线程代码 while true if helloArrived System out println Got hello if bye
  • Java 相当于 Perl 的 s/// 运算符?

    我有一些代码正在从 Perl 转换为 Java 它大量使用了正则表达式 包括s 操作员 我已经使用 Perl 很长时间了 但仍然习惯 Java 的做事方式 特别是 字符串似乎更难使用 有谁知道或有一个完全实现的Java函数s 这样它就可以处
  • 如何让 HttpClient 返回状态码和响应正文?

    我试图让 Apache HttpClient 触发 HTTP 请求 然后显示 HTTP 响应代码 200 404 500 等 以及 HTTP 响应正文 文本字符串 重要的是要注意我正在使用v4 2 2因为大多数 HttpClient 示例都
  • 在 SWT 中单击鼠标触发事件?

    在SWT中 对于MouseListener接口 可用的方法有mouseUp mouseDown and mouseDoubleClick 如何根据用户点击触发事件 我们可以通过结合来做到这一点mouseUp and mouseDown 但没
  • 如何知道 glassfish 是什么 - 完整平台或网络配置文件?

    我已经安装了glassfish 我可以跑 asadmin version 它显示了它是什么版本 但如何知道它是 完整平台 还是 Web 配置文件 你可以使用 glassfish4 bin gt asadmin list containers
  • 整数与 int 比较

    我是新来的java 我现在正在学习非原始整数类型java 我知道以下比较无效并引发编译错误 String str c Char chr c if str chr return true 上面的代码片段给了我 Test java lineNu
  • 在 Java Swing 元素中使用 HTML 样式是不好的做法吗?

    使用 HTML 设置 Swing 元素的样式被认为是不好的做法吗 举个例子 如果我想让标签变大并变红一次 我有两个选择 使用 API 调用 JLabel label new JLabel This is a title label setF
  • 如何找到 Oracle 数据库的 URL?

    如何找到 Oracle 数据库的 URL 和端口 Example jdbc oracle thin host port dbName 用户名 密码 是否有我可以查看的 SQL 命令或日志 配置文件 对于甲骨文来说 有一个tnsnames o
  • 读取不失真的灰度 PNG 图像文件

    我需要读取和处理大量的灰度 PNG 文件 我的意思是 如果它们在 Photoshop 或 GIMP 中打开 则图像模式为灰度 而不是具有灰度值的 RGB 图像 ImageIO 似乎没有实现这一点 它似乎将所有图像文件视为 sRGB 这会破坏
  • Elasticsearch NodeBuilder 与 TransportClient

    对于其他 Elasticsearch 开发人员来说 这可能是一个非常简单 而且愚蠢 的问题 这两者之间有什么区别 我正在从 Java Web 应用程序连接到远程 Elasticsearch 服务器 到目前为止我一直在使用 Transport
  • java.lang.ClassCastException: [B 无法转换为 java.lang.String

    我编写了一个带有字段 LoginId 和密码的实体类 我使用 AES ENCRYPT 加密密码并将其存储在数据库中 我只想检索已解密的密码 所以 我使用 AES DECRYPT 使用本机查询是在 OPen JPA 2 0 中 我写的查询是
  • Visual Studio Code - Java 类路径不完整。只会报告语法错误

    在使用 python 获得了丰富的经验之后 我正在使用 java 迈出第一步 我正在运行的脚本是一个简单的 Java Swing Gui 它可以从命令行和 VS Code 中正常编译和运行 为了设置 java 调试环境 我使用 github
  • 如何从 java.sql.Blob 类型的 zip 文件中读取和提取 zip 条目,而无需将 FileInputStream 或文件路径作为字符串 java

    public static void unzipFiles java sql Blob zip throws Exception String paths byte blobAsBytes zip getBytes 1 int zip le
  • Java“非法访问操作”方法将被弃用? [复制]

    这个问题在这里已经有答案了 JDK 9 JVM 发出非法访问操作警告后 如果您使用一些非法访问 例如setAccessible 我的问题 Is setAccessible 以后会被封吗 此功能的官方参考 如果将被弃用 在哪里 我在任何地方都
  • 文档过滤器在 Java 中不起作用?

    在超过 10 个字符的文本字段中 它必须显示错误 为此 我使用了文档过滤器 JTextField field JTextField txtFld AbstractDocument document AbstractDocument fiel
  • 混合语言源目录布局

    我们正在运行一个使用多种不同语言的大型项目 Java Python PHP SQL 和 Perl 到目前为止 人们一直在自己的私有存储库中工作 但现在我们希望将整个项目合并到一个存储库中 现在的问题是 目录结构应该是什么样的 我们应该为每种
  • 在没有 ODBC 的情况下从 Java 操作 Access 数据库

    我想从我的 Java 项目操作 Microsoft Access 数据库 accdb 或 mdb 文件 我不想使用 Microsoft 的 JDBC ODBC Bridge 和 Access ODBC 驱动程序 因为 JDBC ODBC 桥

随机推荐

  • 【华为OD统一考试A卷

    华为OD统一考试A卷 B卷 新题库说明 2023年5月份 华为官方已经将的 2022 0223Q 1 2 3 4 统一修改为OD统一考试 A卷 和OD统一考试 B卷 你收到的链接上面会标注A卷还是B卷 请注意 根据反馈 目前大部分收到的都是
  • GB28181设备接入端如何播放语音广播数据?

    技术背景 语音广播功能是GB28181设备接入端非常重要的功能属性 语音广播让终端和平台之间 有了实时双向互动 可以满足执法记录仪 智能安全帽 智能监控 智慧零售 智慧教育 远程办公 明厨亮灶 智慧交通 智慧工地 雪亮工程 平安乡村 生产运
  • JavaScript-如何获取字符串长度,如何获取字符串中指定索引的字符,如何从母串中提取子字符串,截取字符串的用法方法详解

    字符串概述 字符串是 JavaScript 的一种基本的数据类型 JavaScript 的字符串是不可变的 String 类定义的方法都不能改变原字符串的内容 var str hello world str abc 当重新给变量 str 赋
  • 神经影像研究驱动的脑龄估计作为脑疾病和健康状况识别的生物学标记

    大量神经影像数据的分析 使研究者对大脑区域的各种解剖分析变得越来越精细 并有助于检测不同的大脑状况和疾病 近年来 由神经影像驱动的脑龄估计被引入作为检测不同疾病和健康状况的有效生物标志物 但由于该类方法在近年来才涌现大量研究结果 还没有研究
  • layui与flask模板语言{{}}冲突的最佳方案

    使用 Jinja2的 raw 和 endraw 标签把 JavaScript 模板部分标记出来即可 raw endraw 但这是就需要注意区分项目中的 的值是jinja2还是layui
  • Blender基础操作:移动、旋转、缩放、删除、抓取、复制

    1 物体的移动 微调面板 Adjust last operation 对上一步操作进行微调 2 物体旋转与缩放 快速归位 几个快捷键 ALT G 坐标归零 ALT R 旋转归零 ALT S 缩放归零 3 删除 抓取 复制 快捷键x 确认后删
  • 论文阅读 - Graph-ToolFormer: To Empower LLMs with Graph Reasoning Ability via Prompt Augmented by ChatGP

    目录 摘要 1 INTRODUCTION 2 相关工作 2 1 Graph Neural Networks 2 2 Language Models 2 3 Prompt Tuning 3 符号 术语定义和问题表述 3 1 Basic Not
  • 关于table标签动态添加多个输入框input

    在做公司的一个项目的时候有个需求 要在表格中动态添加多个input 前台用的easyui 由于当时需求比较急 没做出来 就指定了三个 后面需要改成动态添加一行或多行输入 看过很多文章说用innerHtml或者append方法 试过之后确实可
  • Git 居然可以用来跟女神聊天?

    Git 是用来做啥的 想必码农朋友都知道 Git 是版本控制软件 是软件开发过程中团队协作不可或缺的软件 但是 作为版本控制软件的 Git 能跟聊天工具扯上关系吗 这二者似乎毫无关系 但脑洞大开的外国朋友 Ephi Gabay 就开发了一个
  • 重学 JavaScript 第四天

    for循环 好处 变量起始值 循环条件 变化值写到一起 for循环和while循环区别 当如果明确循环次数的时候推荐使用for循环 当不明确循环次数的时候推荐while循环 循环中断 continue 退出本次循环 继续下一次循环 brea
  • MFC动态链接库弹窗

    目录 一 创建主程序 二 添加MFC动态链接库 三 引用动态链接库 四 编译运行 一 创建主程序 这里使用VS2019进行演示 创建MFC应用 项目名称为MainProgram 应用程序类型为 基于对话框 完成后删除原有控件 再添加一个按钮
  • 指针式仪表的自动读数与识别

    指针式仪表的自动读数与识别 前言 概述 步骤概括 1 仪表图像预处理 2 刻度线提取 2 1轮廓查找 2 2面积筛选 长宽比 距离 2 3刻度线轮廓拟合直线 3 指针轮廓提取 3 1 霍夫直线检测原理 4 结果 5 Pyqt5 5 1功能
  • DragonBones tools龙骨转换spine工具使用

    附上仓库连接 如果进不去需要尝试墙 Tools README zh CN md at master DragonBones Tools GitHub 安装所需依赖 npm install dragonbones tools global 使
  • 数学倒底有没有绝对的严格性和形式化?

    我对数学的理解只停留在大学里的高等代数和微积分 而且毕业后的这 8 年也已经遗忘得差不多了 最近在研究算法 又不得不拾遗和学习一些数学知识 今天这篇文章 希望和大家讨论一个问题 数学到底是否具有绝对的严格性和形式化 恕我愚钝 这个问题让我有
  • ubutun-需要运行NetworkManager

    问题描述 Ubuntu虚拟机没有网络连接 报需要运行NetworkManager 解决方法 root 用户下运行 systemctl start NetworkManager service 原因 不知道 欢迎补充
  • 最大似然估计(ML)

    1 说明 最大似然估计 Maximum Likelihood Estimation ML 是一种在给定观察数据情况下 来评估模型参数的算法 它属于一种统计方法 用来求一个样本集的相关概率密度函数的参数 例如 统计全校人口的身高 我们已知身高
  • boost多边形交集、并集

    交集 http www boost org doc libs 1 56 0 libs geometry doc html geometry reference algorithms intersection html 并集 http www
  • STM32技巧: Keil错误提示“ File Not Found”

    1 文件已添加到工程目录但提示 file not found 原因 仅添加到目录但未包含编译文件的路径 解决 Option gt C C gt Include Paths 添加提示缺失的文件所在路径 错误提示消失
  • vcs -xprop的理解

    一 vcs xprop简介 https www synopsys com zh cn verification simulation vcs xprop html Verilog 和 VHDL 常用于数字设计建模 设计人员使用 RTL 构造
  • 如何在 swgger 中设置连接前后端的 API 接口

    在的网站大多都是前后端分离式的开发 前后端都衍生出了自己的框架 现在前后端交互的唯一方式就是 API 接口 曾经前后端交互都需要后端人员手动编写 API 接口文档 规定路径 请求方式 返回类型 这样效率很低 swagger 就是更好地书写