首页 > 其他分享 >Swagger UI、RESTful简介

Swagger UI、RESTful简介

时间:2024-10-29 10:32:40浏览次数:7  
标签:前端 API UI 使用 Swagger RESTful

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 的范畴。

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

标签:前端,API,UI,使用,Swagger,RESTful
From: https://www.cnblogs.com/hjq111/p/18512419

相关文章

  • UI组件DevExpress ASP.NET Bootstrap - 支持Bootstrap v5.3.3和暗黑模式
    在本文中,我们将详细介绍DevExpressBootstrap控件升级到Bootstrapv5.3.3、增强了DevExpressBootstrap项目模板的安全相关更新,以及对颜色模式的支持等。P.S.:DevExpress ASP.NETBootstrap Controls利用轻量级渲染、响应式布局和现代性能优化技术,扩展网站的受众范围并提高搜索......
  • 【SSM详细教程】-15-Spring Restful风格【无敌详细】
    精品专题:01.《C语言从不挂科到高绩点》课程详细笔记https://blog.csdn.net/yueyehuguang/category_12753294.html?spm=1001.2014.3001.548202.《SpringBoot详细教程》课程详细笔记https://blog.csdn.net/yueyehuguang/category_12789841.html?spm=1001.2014.3001.548203.......
  • 解决elementui中el-radio报错:Blocked aria-hidden on an element because its descend
    今天在使用elment中el-radio的时候发现控制台报错最开始以为是自己哪里写错了,但是后面上网查找的时候发现是浏览器的原因现在来说下解决办法1、可以使用这么一种组合来解决/deep/input[aria-hidden="true"]{display:none!important;}/deep/.el-radio:focus:no......
  • vue使用element ui绘制界面
    vue使用elementui绘制界面搭建Vue脚手架的过程主要依赖于VueCLI(命令行工具)。下面是一个简单的步骤指南,帮助你快速搭建一个Vue项目。步骤1:安装Node.js确保你的系统上已安装Node.js。你可以在Node.js官网下载并安装它。安装完成后,可以在终端中运行以下命令检......
  • 3D在UI上的应用
    一、传统管理系统登录页的局限性在过去,传统的管理系统登录页通常采用平面设计,以简洁的布局和清晰的文字为主。虽然这种设计能够满足基本的功能需求,但也存在一些局限性。 首先,平面设计缺乏立体感和深度感,容易给人单调、乏味的感觉。用户在面对这样的登录页时,往往缺乏足够的视觉......
  • AvaloniaUI项目离线开发全攻略:IDE安装、模板应用与NuGet私有化部署一站式解决
    1.引言在网络受限或完全离线的环境中开发.NET项目(本文示例为AvaloniaUI项目),可能会遇到一些挑战。本文将为您提供一套完整的离线开发解决方案,包括IDE的安装、AvaloniaUI模板的配置、私有化NuGet服务的部署以及NuGet包的制作和上传等。2.IDE安装指南VisualStudio2022安装V......
  • 为什么要生成python项目需要的最小requirements.txt文件?
    在开发Python项目时,你是否曾面临过依赖管理的困扰?随着项目的复杂性增加,如何有效地管理和共享依赖成为了一项关键任务。今天,我们就来探讨为什么生成Python项目需要的最小requirements.txt文件至关重要。那么,为什么每个Python项目都需要一个requirements.txt文件?它对项目的开发......
  • LVGL UI设计神器助你高效开发嵌入式UI应用——v0.15.0发布(中)
    文章目录前言一、Anyui是什么?二、v0.15.0版本的特性新版本检查总结前言随着物联网的到来,凯文・凯利所预言的“屏读”时代也已来临。除了手机、平板电脑这类类似个人电脑的设备之外,越来越多的嵌入式设备也将配备触控显示屏。在资源有限的嵌入式设备上构建一个出......
  • A. Build a Computer
    独立做出了银牌题~线段树划分区间其实无须左闭右开点击查看代码#include<bits/stdc++.h>usingnamespacestd;inttot,id;vector<int>a[1005],c[1005];intt[1005][2];voidadd(intu,intv,intw){a[u].push_back(v);c[u].push_back(w);}voidask(intl,......
  • Tips5 - 在头文件申明库后在Build时显示找不到文件实例
    问题介绍:当使用GetStringNameFromGuid时,它会显示在ShellPkg的Library下,但是当我们使用#include<Library/UefiHandleParsingLib.h>,会说找不到它的实例涉及知识点:这里会牵扯出LibraryClass和LibraryClassInstance的问题:LibraryClass是一组标准的API定义,用于提供某些......