Restful API思路

2023-11-05

1.通过服务器重写规则,将所有请求走一个入口方法,例如index.php的run()方法。

2.通过$_SERVER,找到请求方法,请求路径,请求参数,进行初始化参数

3.根据请求路径,走不同model处理,根据请求方法不同,走不同的处理方法。

4.补充,可以封装错误和异常处理,提前定义好允许的请求方法,等等。

 

以下为补充材料

https://blog.csdn.net/lmseo5hy/article/details/83862383

Restful API接口规范包括以下部分:

一、协议

API与用户的通信协议,总是使用HTTPs协议。

二、域名

应该尽量将API部署在专用域名之下,如https://api.oldboyedu.com;如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下,如https://oldboyedu.com/api/。

三、版本

可以将版本号放在HTTP头信息中,也可以放入URL中,如https://api.oldboyedu.com/v1/

四、路径

路径是一种地址,在互联网上表现为网址,在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"集合"(collection),所以API中的名词也应该使用复数,如https://api.oldboyedu.com/v1/students。

五、HTTP动词

对于资源的具体操作类型,由HTTP动词表示,HTTP动词主要有以下几种,括号中对应的是SQL命令。

1. GET(SELECT):从服务器取出资源(一项或多项);

2. POST(CREATE):在服务器新建一个资源;

3. PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源);

4. PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性);

5. DELETE(DELETE):从服务器删除资源;

6. HEAD:获取资源的元数据;

7. OPTIONS:获取信息,关于资源的哪些属性是客户端可以改变的。

六、过滤信息

如果记录数量很多,服务器不可能都将它们返回给用户,API会提供参数,过滤返回结果,常见的参数有:

1. ?limit=20:指定返回记录的数量为20;

2. ?offset=8:指定返回记录的开始位置为8;

3. ?page=1&per_page=50:指定第1页,以及每页的记录数为50;

4. ?sortby=name&order=asc:指定返回结果按照name属性进行升序排序;

5. ?animal_type_id=2:指定筛选条件。

七、状态码

服务器会向用户返回状态码和提示信息,以下是常用的一些状态码:

1. 200 OK - [GET]:服务器成功返回用户请求的数据;

2. 201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功;

3. 202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务);

4. 204 NO CONTENT - [DELETE]:用户删除数据成功;

5. 400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作;

6. 401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误);

7. 403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的;

8. 404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作;

9. 406 Not Acceptable - [GET]:用户请求的格式不可得;

10. 410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的;

11. 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误;

12. 500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

八、错误处理

如果状态码是4xx,就会向用户返回出错信息,一般来说,返回的信息中将error作为键名,出错信息作为键值。

九、返回结果

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

1. GET /collection:返回资源对象的列表(数组);

2. GET /collection/resource:返回单个资源对象;

3. POST /collection:返回新生成的资源对象;

4. PUT /collection/resource:返回完整的资源对象;

5. PATCH /collection/resource:返回完整的资源对象;

6. DELETE /collection/resource:返回一个空文档。

十、Hypermedia API

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

以上是Restful API设计应遵循的十大规范,除此之外,Restful API还需注意身份认证应该使用OAuth 2.0框架,服务器返回的数据格式,应该尽量使用JSON,避免使用XML。
————————————————
版权声明:本文为CSDN博主「lmseo5hy」的原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接及本声明。
原文链接:https://blog.csdn.net/lmseo5hy/article/details/83862383

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Restful API思路 的相关文章

  • 如何在 CodeIgniter 中取消链接(删除)图像

    我试着unlinkCodeIgniter 中的图像 但是unlink函数显示 注意未定义索引 userfile 这是我的代码
  • 通过链接导航多个对象而不重复

    我正在尝试浏览一堆带有其他对象链接的对象 我想从 id 1 开始并浏览每个对象 有些对象会循环回到之前的对象 所以我想确保每个对象只查看一次 否则我会陷入无限循环 我还希望能够通过链接导航来判断哪些对象无法访问 我认为导航顺序并不重要 这是
  • PHP-FPM 和 Nginx:502 错误网关

    配置 Ubuntu 服务器 11 10 64 位 亚马逊AWS Ec2 托管在云上 t1 micro实例 在我写任何其他内容之前 我想声明我已经检查了两者nginx 502 错误网关 https stackoverflow com ques
  • php将多维数组内爆为制表符分隔行

    我有一个多维数组 BlockData 其中有 13 个维度和 n 个数组元素 我需要将此数组内爆回单个长字符串 其中元素由 n 换行和尺寸由 t tabs 我尝试过使用array map 功能没有成功 需要帮助来完成此任务 请帮忙 这可以使
  • PHP - 如何将图像资源写入文件

    我用了函数imagecopyresampled到裁剪图像 我尝试使用file put contents和 fwrite 将 resized image 写入硬盘上的文件 但所有尝试都失败了 我可以将调整大小的图像写入磁盘而不是使用image
  • 根据选择值显示/隐藏字段

    我试图根据我选择的字段之一的值显示和隐藏一些表单字段 我希望使用数组来保存每个选择值应该显示的内容和不应该显示的内容 以将我从大量的 switch 语句中拯救出来 但无法弄清楚如何做到这一点 我正在使用 PHP 和 jQuery 任何帮助都
  • 将变量设置为函数调用以在 PHP 中的 if 语句中使用

    好的 我正在做一些 Wordpress 编辑 并且编写了一个 if 语句 正如您所看到的 这使用函数调用作为变量 这是因为函数调用会调用当前页面的名称 这很好 然而 当我这样做时 它也往往会与页面上的标题相呼应 这是有道理的 我可能正在尝试
  • 在 woocommerce 管理订单页面中单击自定义按钮运行函数

    基于 在 woocommerce 中的管理订单列表顶部添加一个按钮 https stackoverflow com questions 49437781 add a button on top of admin orders list in
  • PHP 数组到 JavaScript 数组

    假设我在 php 中有这个数组 cities array Caracas gt array air gt array 4 3 5 Working Days Saturday sea gt array 18 3 5 Days Wednesda
  • javascript 和 PHP 中的正则表达式有什么区别吗?

    这是在 javascript 中验证电子邮件地址的正则表达式 我不确定是否可以直接在 PHP 中使用它 a z d u00A0 uD7FF uF900 uFDCF uFDF0 uFFEF a z d u00A0 uD7FF uF900 uF
  • PHP - 当 false 时获取 bool 来回显 false

    以下代码不会打印出任何内容 bool val bool false echo bool val 但下面的代码打印1 bool val bool true echo bool val 有没有更好的打印方法0 or false when boo
  • 多维数组内的移动

    我有一个用表格显示的数组 如何使用用户输入进行移动 目前 0 被分配给每个数组 但我计划为该数组分配其他值 我的问题是 如何使用用户输入在数组内向上 向下 向右 向左移动和对角移动 Array 0 gt Array 0 gt 0 1 gt
  • 如何将 WordPress 类别选择限制为只有一个?

    我有一个自定义帖子类型和一个自定义分类设置 非常标准的东西 但是 我想知道如何限制我的客户在每个帖子中选择多个分类类别 我不介意他们能够创建和删除分类类型 但我不希望他们选择多个分类类型 因为这些是复选框 所以它们可以 也许单选按钮可以工作
  • 获取url,给定的url重定向到

    我从 rss 链接中挖掘数据并获得一堆网址 例如 http feedproxy google com r electricpig 3 qoF8XbocUbE http feedproxy google com r electricpig 3
  • 通过 jQuery 从输入类型=“文件”多个中删除文件

    我在使用 PHP 和 jQuery 上传文件时遇到问题 表单可以一次上传多个图像 这些图像可以在滑块中预览 表单还包含两个字段标题和描述 滑块通过 jQuery 工作 当用户通过单击选择文件来选择多个图像时
  • 使用 Laravel 4 验证多个文件上传

    如何在 Laravel 4 中验证上传文件的数组 我已将其设置为允许多个文件 并且已测试这些文件是否存在于 Input file files 数组中 但如何验证每个文件呢 这是我尝试过的 notesData array date gt In
  • 如何使用 PHP 正确添加跨站请求伪造 (CSRF) 令牌

    我正在尝试为我网站上的表单添加一些安全性 其中一个表单使用 AJAX 另一个表单是简单的 联系我们 表单 我正在尝试添加 CSRF 令牌 我遇到的问题是令牌有时只显示在 HTML 值 中 其余时间 该值为空 这是我在 AJAX 表单上使用的
  • ORDER BY 字段内的 MySQL 子查询。 (没有内连接)

    有很多与此相关的问题 但都具有使用内部联接的相同答案 这 我认为 在这里是不可能的 如果我错了请告诉我 我现在正在做的是调用两个不同的 mysql 查询来获取结果 它工作完美 db gt query SELECT FROM meta WHE
  • Zend Framework 生成唯一的字符串

    我想生成一个唯一的 4 6 个字符长的字母数字字符串 以便与每个记录 用户 一起保存在数据库中 db 字段具有唯一索引 因此尝试保存预先存在的字符串会生成错误 现在我正在生成一个随机字符串并使用 try catch 因此在添加新记录时如果抛
  • PHP 如何判断用户是否按下了 Enter 键或 Submit 按钮?

    我遇到的问题是我在一个表单中有多个提交输入 每个提交输入都有不同的值 我更愿意将它们保留为提交 Whenever the user presses Enter it is as though the topmost submit input

随机推荐

  • 教程四:使用物联网平台控制硬件端

    物美智能 系列文章目录 一款强大的物联网管理平台介绍 物美智能 教程一 阿里云使用docker快速部署服务端 教程二 本地配置服务端开发环境 教程三 硬件端 Arduino和ESP8266开发板入门 教程四 使用物联网平台控制硬件端 教程五
  • 【转】this 的使用方法 —— javascript中的this讲解!

    从自己刚刚开始学习javascript到现在已经很久了 今天得益于新酱的细心讲解 总算是把this这个 雾中花 看清晰了 在此首先感谢新酱的讲解 下面将this的一些基本使用和大家分享一下 查看this指向的一句话法则 永远指向其所在函数的
  • word中公式后面标号右对齐

    版权声明 本文为博主原创文章 转载请标明链接 https blog csdn net zaishuiyifangxym article details 81709319
  • CentOS7服务器安装GPU显卡驱动和CUDA简单方法

    一键安装 通过下载官网runfile程序 自带驱动 参考 Centos7 4安装CUDA9 1 GPU驱动安装 先安装驱动 再安装cuda 参考 CentOS安装nvidia显卡驱动的正确方法 添加ELRpo源 1 导入公钥 rpm imp
  • 实战使用pano2vr生成html5全景页面

    随着现代视觉技术的进步以及对空间展示的迫切需求 很多的无人机可以拍出360度甚至720度全景照片 怎样将全景地图以html5的形式展示出来 文章将详细讲解如何使用pano2vr exe制作全景页面 1 准备pano2vr exe 软件 以w
  • adb 连接某个wifi_一加7 Pro全局强制开启90Hz刷新率的办法(附ADB文件下载)

    要说当前市场上值得买的安卓旗舰有哪几台 上个月刚上市的一加7Pro绝对算一个 一加7Pro最大的卖点就是那块从三星特别定制的6 7英寸QHD分辨率90Hz刷新率 自诩为除三星S10外市场上第二好的AMOLED屏幕 当每一位用过这台能完美呈现
  • JAVA程序入门--数据类型掌握练习《输入个人信息、计算圆的面积、变量交换》

    目录 前言 一 引用 1 Scanner类 1 1 Scanner基本语法 1 2 简单使用 1 3 执行 查看效果 二 练习1 输入个人信息 1 练习内容 2 逻辑梳理 3 整理代码 4 执行结果 三 练习2 计算圆形的面积 1 练习内容
  • git push 提交失败

    提交错误如下 git push origin Enumerating objects 1107 done Counting objects 100 1107 1107 done Delta compression using up to 1
  • 图片转二进制——各种方法汇总

    使用Base64转换图片 利用Base64实现二进制和图片之间的转换 具体代码如下 import java awt image BufferedImage import java io ByteArrayInputStream import
  • win10开始菜单打不开,找不到(没有)本地安全策略

    方法一 看你C盘windows目录下的system32目录下 这两个文件gpedit msc和secpol msc还在不在 不在了就从别的电脑上拷过来 然后点 开始 运行 输入gpedit msc 点确定 如果没有执行 那么就直接去wind
  • linux查看已删除空间却没有释放的进程

    背景 rm删除了文件或者文件夹 df查看时发现没有释放磁盘空间 执行lsof n grep deleted这个命令 root localhost lsof n grep deleted 发现有几个删除了但是没有释放空间 root local
  • Sequence Modeling: Recurrent and Recursive Nets(1)

    CONTENTS Recurrent neural networks or RNNs Rumelhart et al 1986a are a family of neural networks for processing sequenti
  • keil debug如何在watch直接修改变量值_ST福利:如何使用STM32F103C8T6的后64KB flash

    在STM32F103系列芯片中 C8T6 和CBT6均为LQFP48封装 而且差异仅为flash大小区别 C8T6为64KB CBT6为128KB 然而 虽然C8T6的datasheet中标称为64KB 实际上C8T6和CBT6由同一片di
  • Linux Watchdog 机制

    前言 Watchdog 是 Linux 系统一个很重要的机制 其目的是监测系统运行的情况 一旦出现锁死 死机的情况 能及时重启机器 取决于设置策略 并收集crash dump watchdog 顾名思义 看门狗 这就说明 有一个被watch
  • Ubuntu16.04安装jdk1.8

    Ubuntu16 04安装jdk记录 在官网上下载jdk版本 这个步骤就不详细说明 图形化的 很简单 移到 opt 目录下 个人习惯 sudo mv sudo mv jdk 8u151 linux x64 tar gz opt 解压缩到 o
  • 基于antd Tree实现可编辑菜单树,支持节点新增、删除

    基于antd3 Tree实现可编辑菜单树 支持节点新增 编辑 删除 基于antd Tree 实现了可编辑菜单树 支持以下功能 树节点 新增 编辑 删除 提示 以下代码 可参考 一 效果 二 完整代码 1 引入库 代码如下 示例 import
  • camera isp应用

    ISP应用及市场调研报告 1 调研目标及方法 1 1 调研目标 手机摄像头模组用ISP功能模块的市场走向及研发方向 为能够正确认识手机摄像模组行业提供技术及市场依据 2 ISP在模组上的应用原理 图一 手机摄像模组后端处理IC功能划分图 2
  • 锁相环工作原理

    锁相环 Phase Locked Loop 相位 锁 环路 简称 PLL 基本构成 f1 是输入频率 f2是输出频率 并且反馈给鉴相器 压控振荡器 压控振荡器的全称是 Voltage Controlled Oscillator 电压 控制
  • Unix时间戳和北京时间的相互转换(C语言实现 )

    一 问题背景 最近物联网项目中需要上传包含时间戳的设备数据到服务器平台 原本想把 年 月 日 时 分 秒 分别用一个 uint8 t 的数据类型去存储 即占用6个字节 但是在平台配置协议时 只有一种叫 Unix时间戳 的数据类型 Unix时
  • Restful API思路

    1 通过服务器重写规则 将所有请求走一个入口方法 例如index php的run 方法 2 通过 SERVER 找到请求方法 请求路径 请求参数 进行初始化参数 3 根据请求路径 走不同model处理 根据请求方法不同 走不同的处理方法 4