开发模式、API接口

news2024/11/26 15:48:29

文章目录

    • 一、web开发模式
      • 1.1 前后端混合开发
      • 1.2 前后端分离开发
    • 二、API接口
      • 2.1 简介
      • 2.2 RESTful API接口规范

道阻且长，行则将至，行而不辍，未来可期🌟。人生是一条且漫长且充满荆棘的道路，一路上充斥着各种欲望与诱惑，不断学习，不断修炼，不悔昨日，不畏将来！
希望这篇能够带给你们或多或少的帮助，诸位！顶峰见 🚀

一、web开发模式

在web应用中，有两种开发模式：

1.1 前后端混合开发

也可以理解为：前后端不分离开发
在这里插入图片描述
前端的一些数据都是在后端通过模板语法渲染好以后再响应给浏览器。

大致开发流程：

  • 前端写好静态文件交付给后端作为模板进行开发。
  • 后端根据模板语法（变量、以及一些逻辑操作）渲染数据到模板上。
  • 遇到模板本身的问题再交付给前端进行修改，然后再交付给后端直到项目开发完成。

缺点：

在前端调试的时候要安装完整的一套后端开发工具，要把后端程序完全启动起来。遇到问题需要后端
开发来帮忙调试。我们发现前后端严重耦合，还要要求后端人员会一些HTML，JS等前端语言。
前端页面里还嵌入了很多后端的代码。一旦后端换了一种语言开发，简直就要重做。
像这种增加了大量的沟通成本，调试成本等，而且前后端的开发进度相互影响，从而大大降低了开发效率。

1.2 前后端分离开发

在这里插入图片描述
前后端分离并不只是一种开发模式，也web应用的属于一种架构模式。在开发阶段，前后端工程师需要提前规定好数据交互的接口，实现并行开发测试；推荐采用RESTful接口规范

前后端混合开发：

在传统架构模式中，前后端代码存放于同一个代码库中，甚至是同一工程目录下。页面中还夹杂着后端代码。前后端工程师进行开发时，都必须把整个项目导入到开发工具中。

一但后端更换编程语言，整个项目的后端功能都将需要重新重新开发。

前后端分离开发：

前后端代码库分离，前端代码中有可以进行Mock测试(通过构造虚拟测试对 象以简化测试环境的方法)的伪后端，能支持前端的独立开发和测试。而后端代码中除了功能实现外，还有着详细的测试用例，以保证API的可用性，降低集成风险。

后端即使更换编程语言，只要确保返回的接口前端能够获取需要的数据就不会出现问题。


二、API接口

2.1 简介

为了在团队内部形成共识、防止个人习惯差异引起的混乱，我们需要找到一种大家都觉得很好的接口实现规范，而且这种规范能够让后端写的接口，用途一目了然，减少双方之间的合作成本。

通过网络，规定了前后台信息交互规则的url链接，也就是前后台信息交互的媒介

Web API接口和一般的url链接还是有区别的，Web API接口简单概括有下面四大特点：

  • url：长得像返回数据的url链接
    • https://api.map.baidu.com/place/v2/search

  • 请求方式：get、post、put、patch、delete
    • 采用get方式请求上方接口

  • 请求参数：json或xml格式的key-value类型数据
    • ak：6E823f587c95f0148c19993539b99295
    • region：武汉
    • query：肯德基
    • output：json

  • 响应结果：json或xml格式的数据
    • 上方请求参数的output参数值决定了响应数据的格式
    • 数据
    XML格式数据：https://api.map.baidu.com/place/v2/searchak=6E823f587c95f0148c19993539b99295&region=%E6%AD%A6%E6%B1%89&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=xml
JSON格式数据：https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E6%AD%A6%E6%B1%89&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=json

2.2 RESTful API接口规范

在这里插入图片描述
REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征性状态转移）。 它首次出现在2000年Roy Fielding的博士论文中。

RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。

这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。

事实上，我们可以使用任何一个框架都可以实现符合restful规范的API接口。

1、数据的安全保障

  • url链接一般都采用https协议进行传输

注：采用https协议，可以提高数据交互过程中的安全性

2、接口特征表现

  • 用api关键字标识接口url：
    • https://api.baidu.com
    • https://www.baidu.com/api
  • 注：看到api字眼，就代表该请求url链接是完成前后台数据交互的

3、多数据版本共存

  • 在url链接中标识数据版本
    • https://api.baidu.com/v1
    • https://api.baidu.com/v2
  • 注：url链接中的v1、v2就是不同数据版本的体现（只有在一种数据资源有多版本情况下）

4、数据即是资源，均使用名词（可复数）

  • 接口一般都是完成前后台数据的交互，交互的数据我们称之为资源

    • https://api.baidu.com/users
    • https://api.baidu.com/books
    • https://api.baidu.com/book

  • 注：一般提倡用资源的复数形式，在url链接中奖励不要出现操作资源的动词，错误示范：https://api.baidu.com/delete-user

  • 特殊的接口可以出现动词，因为这些接口一般没有一个明确的资源，或是动词就是接口的核心含义

  • https://api.baidu.com/place/search

  • https://api.baidu.com/login

5、资源操作由请求方式决定（method）

  • 操作资源一般都会涉及到增删改查，我们提供请求方式来标识增删改查动作
  • https://api.baidu.com/books - get请求：获取所有书
  • https://api.baidu.com/books/1 - get请求：获取主键为1的书
  • https://api.baidu.com/books - post请求：新增一本书书
  • https://api.baidu.com/books/1 - put请求：整体修改主键为1的书
  • https://api.baidu.com/books/1 - patch请求：局部修改主键为1的书
  • https://api.baidu.com/books/1 - delete请求：删除主键为1的书

6、过滤，通过在url上传参的形式传递搜索条件

  • https://api.example.com/v1/zoos?limit=10：指定返回记录的数量
  • https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置
  • https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数
  • https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
  • https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件

7、响应状态码

  • 7.1 正常响应

    • 响应状态码2xx
      • 200：常规请求
      • 201：创建成功

  • 7.2 重定向响应

    • 响应状态码3xx
      • 301：永久重定向
      • 302：暂时重定向

  • 7.3 客户端异常

    • 响应状态码4xx
      • 403：请求无权限
      • 404：请求路径不存在
      • 405：请求方法不存在

  • 7.4 服务器异常

    • 响应状态码5xx
      • 500：服务器异常

8、错误处理，应返回错误信息，error当做key

{
    error: "无权限操作"
}

9、返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范

  • GET /collection：返回资源对象的列表（数组）
  • GET /collection/resource：返回单个资源对象
  • POST /collection：返回新生成的资源对象
  • PUT /collection/resource：返回完整的资源对象
  • PATCH /collection/resource：返回完整的资源对象
  • DELETE /collection/resource：返回一个空文档

10、响应中携带URL

Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么

{
  	"status": 0,
  	"msg": "ok",
  	"results":[
        {
            "name":"肯德基",
            "img": "https://image.baidu.com/kfc/001.png"
        }
      	...
		]
}

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

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

rtdetr:paddledetection与ultralytics对比

rtdetr:paddledetection与ultralytics对比

转眼间，自DETR被提出已经过去了2年了，如今又迎来了2023年，可以说，这是Transformer框架在CV领域发力的第3个年头了。时至今日，对Transformer的质疑声越来越小了，它的强大得到了越来越多、越来越广泛的认可。…
阅读更多...
进程与线程的基本概念和代码实现

进程与线程的基本概念和代码实现

1 前言 利用现学知识能够让两个函数或者方法同时执行吗? 不能，因为之前所写的程序都是单任务的，也就是说一个函数或者方法执行完成另外一个函数或者方法才能执行，要想实现这种操作就需要使用多任务。 多任务的最大好处是充分利用CPU资源&a…
阅读更多...
超好用的检测模块---SUI-101A交流变送器

超好用的检测模块---SUI-101A交流变送器

前言： SUI-101A交流变送器作为高精度交流变送器，可以高精度获取电压、电流、有功功率、功率因素、频率、电量等电参数，并且低功耗，实时性好、操作方便快捷，同时可以隔离高压，便于进行安全测量。 SUI-101A模…
阅读更多...
qt for android 开发之tcp通讯

qt for android 开发之tcp通讯

简介 通过TCP使PC和android手机相互通讯。 准备 使用QT的网络模块 QT core gui networkgreaterThan(QT_MAJOR_VERSION, 4): QT widgets.h 定义TCP接口 #include <QTcpSocket>class MainWindow : public QMainWindow {Q_OBJECTpublic:explicit MainWindow(Q…
阅读更多...
日本最大港口遭勒索软件攻击，造成巨大经济影响！

日本最大港口遭勒索软件攻击，造成巨大经济影响！

日本名古屋港位于伊势湾&#xff0c;是日本最大和最繁忙的贸易港口&#xff0c;占全国总贸易量的10%左右。值得注意的是&#xff0c;这个港口还是日本最大的汽车出口国&#xff0c;丰田汽车公司的大部分汽车都在这里出口。 近日该港口遭遇了一次勒索软件攻击&#xff0c;影响了…
阅读更多...
Maven使用IDEA自带工具打包，同时将lib下的jar包打入，双击jar包可直接运行

Maven使用IDEA自带工具打包，同时将lib下的jar包打入，双击jar包可直接运行

前言 使用IDEA自带打包工具&#xff0c;可以将自己引入的第三方jar包&#xff08;lib下的jar包&#xff0c;非pom文件中&#xff09;打包到jar中。 Artifacts是maven中的一个概念&#xff0c;表示某个module要如何打包&#xff0c;例如war exploded、war、jar、ear等等这种打…
阅读更多...
Python 函数耗时异常自动化监控实战教程

Python 函数耗时异常自动化监控实战教程

内容 隐藏 一、性能数据函数耗时采集及可视化报表生成 1. 性能数据文件保存&#xff08;cProfile&#xff09; 2. 详细性能数据读取查看 二、生成函数调用栈结构图&#xff08;gprof2dot&#xff09;教程 三、性能分析及优化实战 四、耗时异常自动化监控 1. 正态分布数据方…
阅读更多...
mysql 主从复制配置步骤

mysql 主从复制配置步骤

1、准备两台数据库环境&#xff0c;或者单台多实例环境&#xff0c;能否正常启动和登录。 2、配置my.cnf文件&#xff0c;主库配置log-bin和server-id参数&#xff0c;从库配置server-id&#xff0c;不能和主库及其他从库一样&#xff0c;一般不开启从库log-bin功能。注意&…
阅读更多...
基于STM32的土壤湿度传感器使用

基于STM32的土壤湿度传感器使用

基于STM32的土壤湿度传感器使用 最近在学习中用到了ADC数据采集这里使用的硬件模块为土壤湿度传感器&#xff0c;下面为土壤传感器相关的使用方法和代码介绍。 1、土壤湿度传感器实物图 土壤湿度传感器一共有4个引脚分别为&#xff1a; GND VCC DO AO&#xff0c;在本次实验中使…
阅读更多...
macbook按u键入笔画

macbook按u键入笔画

mac自带输入法提供了笔画输入快捷方式&#xff0c;键入u会自动变成笔画输入 当遇到不会念的字的时候还是很有用的 横、竖、撇、捺、折、写 上面的拼音首字母对应了比划&#xff0c;非前五个笔画的时候就用 x&#xff08;写&#xff09;替代 比如&#xff1a;彳亍 第一个字输…
阅读更多...
php宝塔部署开源NXCRM客户管理系统开源源码

php宝塔部署开源NXCRM客户管理系统开源源码

注意&#xff1a;因为微信最近又改了推送机制&#xff0c;经常有朋友说错过了之前的搭建教程文章&#xff0c;每次都要主动搜索才能搜到公众号。所以建议大家加个星标&#xff0c;就能第一时间收到推送。 大家好啊&#xff0c;我是测评君&#xff0c;欢迎来到web测评。本期给大…
阅读更多...
【UnityDOTS 十三】Cleanup Component

【UnityDOTS 十三】Cleanup Component

Cleanup Component 前言 一种特殊的组件&#xff0c;当Entity销毁时&#xff0c;要独立移除这个组件。 意味着当你删除一个Entity后&#xff0c;这个组件还存在&#xff0c;那么该Entity也会存在。 主要用于创建Entity时&#xff0c;进行初始化操作&#xff1b;或者销毁时&a…
阅读更多...
Base64码转换成图片

Base64码转换成图片

一、在浏览器地址栏输入 data:image/png;base64, 生成的base64码 1、示例&#xff1a; data:image/png;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAg... 2、访问转换结果&#xff1a; 小结&#xff1a; 1、转换支持 png 格式&#xff1a;data:image/png;base64, 生成的b…
阅读更多...
simulink 一阶低通滤波器

simulink 一阶低通滤波器

设计一个波来测试
阅读更多...
分布式监控zabbix的使用（一）

分布式监控zabbix的使用（一）

zabbix 一、添加zabbix客户端主机&#xff0c;测试是否能连接服务端和客户端都设置 hosts 解析设置 zabbix 的下载源&#xff0c;安装 zabbix-agent2修改 agent2 配置文件通过键值测试连通性在 Web 页面中添加 agent 主机 二、自定义监控内容在客户端创建自定义key 三、在web页…
阅读更多...
Layui表单table渲染+条件查询

Layui表单table渲染+条件查询

&#x1f607;作者介绍&#xff1a;一个有梦想、有理想、有目标的&#xff0c;且渴望能够学有所成的追梦人。 &#x1f386;学习格言&#xff1a;不读书的人,思想就会停止。——狄德罗 ⛪️个人主页&#xff1a;进入博主主页 &#x1f5fc;专栏系列&#xff1a;点击进入专栏 &a…
阅读更多...
计算两个经纬度之间的距离

计算两个经纬度之间的距离

js 代码 function GetDistance( lat1, lng1, lat2, lng2){var radLat1 lat1*Math.PI / 180.0;var radLat2 lat2*Math.PI / 180.0;var a radLat1 - radLat2;var b lng1*Math.PI / 180.0 - lng2*Math.PI / 180.0;var s 2 * Math.asin(Math.sqrt(Math.pow(Math.sin(a/2),2) …
阅读更多...
软件安全的重要保障手段之漏洞扫描

软件安全的重要保障手段之漏洞扫描

漏洞扫描是保障软件安全的一项重要手段&#xff0c;它可以帮助发现软件中存在的安全漏洞&#xff0c;并及时修补这些漏洞&#xff0c;以提高软件的安全性。在当前信息时代&#xff0c;软件安全问题日益凸显&#xff0c;因此选择一个靠谱的软件测评中心进行漏洞扫描非常重要。 …
阅读更多...
【裴属定理】Wannafly挑战赛22 A

【裴属定理】Wannafly挑战赛22 A

A-计数器_Wannafly挑战赛22 (nowcoder.com) 题意&#xff1a; 思路&#xff1a; Code&#xff1a; #include <bits/stdc.h>#define int long longusing namespace std;const int mxn1e510; const int mxe1e510; const int mod998244353; const int Inf0x3f3f3f3f;int N…
阅读更多...
ncnn源码阅读(二)----网络模型结构和权重参数的加载

ncnn源码阅读(二)----网络模型结构和权重参数的加载

网络模型结构和权重参数的加载 ncnn推理框架中把模型的结构和权重参数分为两个文件进行存储&#xff0c;实现了结构和权重的分离。在xxx.param中存储了模型的结构信息&#xff0c;在xxx.bin中存储了模型的权重信息。xxx.param的文件结构如下&#xff1a; layer&#xff1a;描…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023