Swagger UI、RESTful简介

news/2025/1/22 8:31:26/文章来源:https://www.cnblogs.com/hjq111/p/18512419

Swagger UI 简介


Swagger UI允许任何人(无论您是开发团队还是最终用户)都可以可视化API资源并与之交互,而无需任何实现逻辑。它是根据您的OpenAPI(以前称为Swagger)规范自动生成的,具有可视化文档,可简化后端实现和客户端使用。

SwaggerUI 特点
无依赖 UI可以在任何开发环境中使用,无论是本地还是在Web端中。
人性化 允许最终开发人员轻松地进行交互,并尝试API公开的每个操作,以方便使用。
易于浏览 归类整齐的文档可快速查找并使用资源和端点。
所有浏览器支持 Swagger UI 在所有主要浏览器中均可使用,以适应各种可能的情况。
完全可定制 通过完整的源代码访问方式以所需方式设置和调整Swagger UI。
完整的OAS支持 可视化Swagger 2.0或OAS 3.0中定义的API。
前后端分离

Vue + SpringBoot
后端时代:前端只用管理静态页面; html==》后端。 模版引擎 JSP=>后端是主力

前后端分离时代:

后端:后端控制层、服务层、数据访问层 【后端团队】
前端:前端控制层、视图层 【前端团队】
伪造后端数据,json。在后端开发前数据以及存在,不需要后端,前端工程师依旧能将项目跑起来。
前后端如何交互? ==>API
前后端相对独立,松耦合;
前后端甚至可以部署在不同的服务器上。
产生一个问题

前后端集成联调,前端人员和后端人员无法做到 “及时协商,尽早解决”,最终导致问题集中爆发;
解决方案:

首先指定schema[计划的提纲],实时更新最新的API,降低集成的风险。
早些年,制定Word计划文档
前后端分离:
前端测试后端接口使用:Postman工具。
后端提供接口:需要实时更新最新改动和消息。
Swagger登场
号称世界上最流行的API框架。
Restful API文档在线自动生成工具 API文档与API定义同步更新。
直接运行,可以在线测试API接口。
支持多种语言 如:Java 、PHP…
官网
https://swagger.io/

在项目只能使用SwaggerUI
需要使用Springfox,配置的组件有

Swagger 2
UI 显示页面

转载链接:https://blog.csdn.net/zhanshixiang/article/details/104605292

 

API(Application Programming Interface) 翻译过来是应用程序编程接口的意思。

我们在进行后端开发的时候,主要的工作就是为前端或者其他后端服务提供 API 比如查询用户数据的 API 。

但是, API 不仅仅代表后端系统暴露的接口,像框架中提供的方法也属于 API 的范畴。

为了方便大家理解,我再列举几个例子 🌰:

  1. 你通过某电商网站搜索某某商品,电商网站的前端就调用了后端提供了搜索商品相关的 API。
  2. 你使用 JDK 开发 Java 程序,想要读取用户的输入的话,你就需要使用 JDK 提供的 IO 相关的 API。
  3. ……

你可以把 API 理解为程序与程序之间通信的桥梁,其本质就是一个函数而已。另外,API 的使用也不是没有章法的,它的规则由(比如数据输入和输出的格式)API 提供方制定。

何为 RESTful API?

RESTful API 经常也被叫做 REST API,它是基于 REST 构建的 API。这个 REST 到底是什么,我们后文在讲,涉及到的概念比较多。

如果你看 RESTful API 相关的文章的话一般都比较晦涩难懂,主要是因为 REST 涉及到的一些概念比较难以理解。但是,实际上,我们平时开发用到的 RESTful API 的知识非常简单也很容易概括!

举个例子,如果我给你下面两个 API 你是不是立马能知道它们是干什么用的!这就是 RESTful API 的强大之处!

GET    /classes:列出所有班级
POST   /classes:新建一个班级
 

RESTful API 可以让你看到 URL+Http Method 就知道这个 URL 是干什么的,让你看到了 HTTP 状态码(status code)就知道请求结果如何。

像咱们在开发过程中设计 API 的时候也应该至少要满足 RESTful API 的最基本的要求(比如接口中尽量使用名词,使用 POST 请求创建资源,DELETE 请求删除资源等等,示例:GET /notes/id:获取某个指定 id 的笔记的信息)。

转载连接:https://javaguide.cn/system-design/basis/RESTfulAPI.html#%E4%BD%95%E4%B8%BA-restful-api

 

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.hqwc.cn/news/823597.html

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Ubuntu QTCreator 程序打包

下载linuxdeployqt官网地址:https://github.com/probonopd/linuxdeployqt/releases安装更改名字 mv linuxdeployqt-6-x86_64.AppImage linuxdeployqtView Code修改权限 chmod 777 linuxdeployqtView Code全局访问 sudo mv linuxdeployqt /usr/local/binView Code测试 linuxdep…

❗Vue中常见的性能优化(被问到要尽可能说全呀cc!!!)

Webpack层级的优化(后面会讲) 前端通用的性能优化,如图片懒加载 使用SSR

算法与数据结构——计数排序

计数排序 计数排序(counting sort)通过统计元素数量来实现排序,通常应用于整数数组。 简单实现 给定一个长度为n的数组nums,其中的元素都是“非负整数”,计数排序的整体流程如下:遍历数组,找出其中最大的数组,记为m,然后创建一个长度为 m+1 的辅助数组counter。 借助c…

二分类结果评估指标

TP(True Positive):真正例,真值和预测值都是正例FP(False Positive):假正例,真值是负例,预测值是正例FN(False Negative):假负例,真值是正例,预测值是负例TN(True Negative):真负例,真值和预测值都是负例Accuracy(准确率):对于给定的测试数据集,分类器正…

GaussDB的行存表与列存表的选择

一、前言 行存表和列存表是数据库中两种常见的数据存储方式。随着信息技术的飞速发展,数据存储和管理以及如何高效地存储和处理大量的数据已经成为了我们的一大挑战。 为了解决这个问题,行存表与列存表应运而生,它们以其独特的优势在各个场景得到了高效的应用。GaussDB支持行…

什么是PlatformIo

PlatformIO是一个开源的物联网开发生态系统,它为多种硬件平台和开发环境提供了一致的、跨平台的开发体验,从而降低开发复杂性、提高开发效率。本文将详细解析PlatformIO的核心组成部分,运行原理以及在实际应用中的作用和优势。PlatformIO提供了统一的项目管理工具,包括项目…

麒麟系统修改镜像地址,并安装数据库mariadb

1.跳转到镜像源文件夹 cd /etc/yum.repos.d 2.备份系统镜像源文件 ps:要养成修改系统文件之前做文件备份的好习惯 cp kylin_aarch64.repo kylin_aarch64.repo.bak 3.修改的镜像源 vi kylin_aarch64.repo[ks10-adv-cdrom] name = Kylin Linux Advanced Server 10 - cdrom baseur…

强化学习的数学原理-05蒙特卡洛方法

目录MC BasicMC Exploring StartsMC Epsilon-Greedy MC Basic 从\(model \: base \:\)的\(Reinforcement \: learning \:\)过渡到\(model \: free \:\)的\(\: Reinforcement \: learning \:\)最难以理解的是怎么在没有模型的情况下去估计一些量。 这里面就有一个重要的\(\: id…

关于我卖的苹果~(甘肃-天水-山区-结果之后没打农药)

尽快发货❗🍎一大箱纯红富士120(小箱60)。🍎一大箱三合一100(小箱50)。⛰️自家种的,昼夜温差大。味道比较甜。一箱大概15斤。纯大果。 本文来自博客园,作者:一石数字欠我15w!!!,转载请注明原文链接:https://www.cnblogs.com/52-qq/p/18512197

关于我卖的苹果~(甘肃-天水-山区)

尽快发货❗🍎一大箱纯红富士120(小箱60)。🍎一大箱三合一100(小箱50)。⛰️自家种的,昼夜温差大。味道比较甜。一箱大概15斤。纯大果。 本文来自博客园,作者:一石数字欠我15w!!!,转载请注明原文链接:https://www.cnblogs.com/52-qq/p/18512197

法律智能助手:思通数科开源NLP系统助力文档分类与检索加速

一、系统概述 思通数科AI平台是一款融合了自然语言处理和多标签分类技术的开源智能文档分类工具,特别适用于法律行业。平台采用深度学习的BERT模型来进行特征提取与关系抽取,实现了精准的文档分类和检索。用户可以在线训练和标注数据,使系统持续学习,准确率、召回率等指标随…

ClearCLIP:倒反天罡,删除两个组件反而可以提升密集预测性能 | ECCV24

来源:晓飞的算法工程笔记 公众号,转载请注明出处论文: ClearCLIP: Decomposing CLIP Representations for Dense Vision-Language Inference论文地址:https://arxiv.org/abs/2407.12442 论文代码:https://github.com/mc-lan/ClearCLIP创新点发现两个关键因素在将CLIP适配密…