为什么调用API总返回404,该如何调试

当调用一个应用程序接口(API)时,持续地收到“404 未找到”的错误,其核心原因在于客户端发起的“请求”,未能成功地,匹配到服务器上任何一个“真实存在”的、可供访问的“资源路径”。这本质上,是一个“寻址失败”的问题。导致这种“寻址失败”的“罪魁祸首”,通常涵盖了五个层面:请求的“统一资源定位符”路径错误、请求的“HTTP方法”不匹配、服务端“路由”配置缺失或错误、资源本身因“业务逻辑”而确实不存在、以及网络中的“代理”或“防火墙”拦截

其中,请求的“统一资源定位符”路径错误,是最为普遍、也最容易被忽略的直接原因。一个多余的斜杠、一个微小的拼写错误、或是开发环境与生产环境的基础路径差异,都足以让一个看似“完美”的请求,变成一次“寄往不存在地址的信件”。服务器,作为一个严谨的“邮局”,在无法找到这个“地址”时,便会忠实地,返回一个404状态码,以告知客户端:“你所请求的资源,在此处,并不存在。”

一、错误的“本质”、理解404 Not Found的“官方”含义

在开始进行“排查”这一技术性动作之前,我们必须首先,在“认知”层面,对404这个状态码,建立一个精准的、无歧义的理解。错误地理解一个问题的“定义”,常常会导致我们,在错误的“方向”上,浪费大量的调试时间

1. 404不是“服务器崩溃”

首先,必须明确,404是一个客户端错误码(属于4xx系列)。它所传递的核心信息是:“服务器,已经成功地,接收并理解了你的请求,但是,在服务器上,找不到你所请求的那个特定的资源。” 这与5xx系列的服务器错误(例如,500内部服务器错误,或503服务不可用),有着本质的区别。收到404,意味着,服务器本身,是“健康”且“在线”的。问题,出在了我们客户端,所发起的“请求”本身。

2. 404不是“无权限”

其次,404也不同于401 未授权403 禁止访问

401意味着:“你需要先‘登录’,我才能告诉你,这里有没有东西。”

403意味着:“我知道这里有东西,但根据你的‘身份’,我明确地‘禁止’你访问它。”

404则意味着:“我(服务器)已经确认了你的身份,并帮你找过了,但你所请求的那个‘地址’,在我的管辖范围内,真的,就是‘空’的。”

3. 一个关于“邮局”的说明

我们可以用一个简单的生活化说明,来理解这个差异。

  • 5xx错误:相当于,邮局,因为内部装修或罢工,而“关门大吉”了。
  • 401/403错误:相当于,邮局正常营业,但这封信,因为是“机密”文件,你没有出示相应的“证件”,而被门卫“拦下”了。
  • 404错误:则相当于,邮局正常营业,门卫也确认了你的身份,但你信封上写的那个“幸福大街888号”,在整个城市的地图上,都查无此地

因此,所有关于404错误的调试,其核心,都应围绕着“寻址”这条主线展开

二、排查路径一、检查“地址” - 统一资源定位符

这是排查404问题的第一步,也是最容易发现问题的一步。统一资源定位符(通常指网址),就是我们寄往服务器那封“信”的“地址”。

1. 基础路径与域名

首先,检查构成地址的“主干”部分。

协议是否正确? http:// 还是 https://?在一个强制要求安全连接的服务器上,使用非加密的协议,可能会被重定向或拒绝。

域名或IP地址是否正确? 是否存在拼写错误?你是否,错误地,将一个请求,发往了“测试”环境的域名,而非“生产”环境的域名?(例如,api.test.example.com vs api.example.com

端口号是否正确? 如果接口服务,运行在一个非标准的端口上(例如,8080),你是否,在地址中,正确地包含了它?

基础路径是否正确? 许多接口,都有一个统一的“基础路径”(例如,/api/v2/)。这个基础路径,是否存在拼写错误,或者,版本号是否正确?

2. 资源路径与拼写

这是最低级,但也最常见的错误。人脑,在阅读时,会自动地,纠正微小的拼写错误,但计算机,不会。

/users/123 对比 /user/123 (多了一个s)

/product/details 对比 /product/detials (元音字母ai的颠倒)

/order-summary 对比 /order_summary (连接符 - 与下划线 _ 的混淆) 在排查时,最可靠的方法,不是用“肉眼”去看,而是直接地,从接口文档中,“完整地、精确地,复制”出路径字符串,并与你代码中的,进行一次“文本对比”

3. 路径参数的格式

在现代的**RESTful API**设计中,我们常常,将资源的唯一标识,作为路径的一部分。

场景:服务器端的路由,被定义为 /users/{id},并且,为了健壮性,对id这个“路径参数”,做出了“必须是数字”的类型约束。

问题:客户端,因为某种原因,传递了一个“非数字”的标识,例如 /users/abc

后果:这个请求,虽然在“形状”上,看起来,与路由匹配,但因为它,不满足“参数必须是数字”的这个“前置约束”,所以,路由系统,会直接判定为“不匹配”,并返回404

三、排查路径二、检查“开门方式” - 请求方法

如果,我们100%地,确认了“地址”是正确的,那么,第二个需要排查的,就是我们去访问这个地址的“方式”——即请求方法

1. 资源与方法的“契约”

在现代的、规范的接口设计中,“资源”(由地址表示)与“方法”(如GET, POST, PUT, DELETE等),存在着一种强绑定的“契约”关系。同一个地址,对于不同的请求方法,其所代表的“操作”,是完全不同的。

GET /users:通常,代表“获取”一个用户列表。

POST /users:通常,代表“创建一个”新的用户。

2. 最常见的混淆:GETPOST

场景:开发者,需要,实现一个“创建新用户”的功能。他正确地,将请求,发送到了/users这个地址。但是,他所使用的请求方法,却是浏览器默认的GET方法。

问题分析:然而,在服务器端,工程师,只为/users这个地址,配置了用于处理“创建”逻辑的POST方法路由。服务器的路由表里,根本不存在一个GET /users的路由规则。

后果:当这个GET请求,到达服务器时,路由系统,在自己的“地图”上,找不到任何一个,能够同时匹配“/users地址”和“GET方法”的“目的地”。因此,它只能,向客户端,返回一个404

四、排查路径三、审视“服务器” - 路由与逻辑

如果,“地址”和“方式”,都已确认无误,那么,我们就需要,将排查的目光,从“客户端”,转向“服务器端”。

1. 路由“未定义”或“配置错误”

这是最直接的服务器端原因。客户端,在请求一个,后端开发者,“忘记”了去创建或配置的路由。或者,在路由的配置中,存在微小的拼写错误。这种情况,在前后端分离的、并行的开发模式中,尤为常见。

2. 中间件的“拦截”

在现代的Web框架中,“中间件”是一个非常普遍的概念。它如同,在请求到达“最终的目的地”(即业务逻辑处理器)之前,所必须经过的一系列“安检站”。

场景:一个接口,可能,需要经过“身份认证中间件”、“权限校验中间件”、“请求体解析中间件”等。

问题:如果,其中某个中间件,出现了配置错误,或者,我们的请求,未能满足某个中间件的“前置要求”(例如,缺少了一个必要的请求头),那么,这个中间件,就可能,会提前地,中断整个请求的处理流程,并直接,向客户端,返回一个错误。在某些配置下,这个错误,就可能是404

3. 业务逻辑导致的“假性”404

这是一个极其重要,也极具迷惑性的情况

场景:客户端,请求 /users/999,试图获取ID为999的用户信息。

服务器端行为

服务器的路由系统,成功地,匹配到了/users/{id}这个路由规则。

请求,被成功地,传递给了,处理这个路由的业务逻辑函数

在这个函数内部,程序,去数据库中,查询id = 999的用户。

查询结果为“”,即,数据库中,不存在这个用户。

此时,后端的开发者,主动地、有意识地,在其业务代码中,决定,向客户端,返回一个404状态码

分析:在这种情况下,404,并非一个“路由”层面的错误,而是一个“业务逻辑”层面的、被有意返回的结果。它所传递的语义,是“你所请求的这个‘资源实例’,在我们的业务数据中,不存在”,这,恰恰是404状态码,最精准的、语义化的应用之一。

五、系统性的“调试”与“预防”

1. 调试工具箱

浏览器开发者工具“网络”面板,是所有Web API调试的“第一站”。它能够,像一个“行车记录仪”一样,完整地,记录下,每一次请求的所有细节:完整的请求地址、请求方法、请求头、请求体、以及服务器返回的完整响应

接口测试工具:像PostmancURL这样的工具,允许你,脱离自己复杂的前端代码,去独立地、干净地,对一个接口,进行调用。这能够帮助你,快速地,隔离和定位,问题,到底是出在“你自己的调用代码”,还是“接口本身”。

服务器端日志:这是“最终的真相”。通过查看服务器的“访问日志”和“应用错误日志”,我们可以确定无疑地知道:我们的请求,到底,有没有“到达”服务器?如果到达了,服务器,又是如何处理它,并在哪个环节,最终决定,返回404的?

2. 预防策略

使用接口定义语言:像**OpenAPI (Swagger)**这样的工具,允许我们,用一种“机器可读”的、标准化的格式,来定义接口的“合同”。基于这份“合同”,我们可以,自动地,生成客户端的调用代码、服务器端的路由框架、以及接口的交互式文档。这种“代码生成”的方式,能够从根本上,杜绝因“手动”编写,而导致的各种拼写和类型错误。

建立清晰的文档与规范:接口的文档,必须被视为与代码同等重要的“交付物”。

端到端的集成测试:建立自动化的“集成测试”,来模拟真实的前后端交互。这些测试,能够在每次代码变更后,自动地,检查出,是否引入了任何导致404的路由或契约破坏。

常见问答 (FAQ)

Q1: 404(未找到)和 403(禁止访问)有什么区别?

A1: 404表示,服务器,找不到你所请求的资源地址,它强调的是“不存在”。而403则表示,服务器,找到了你请求的资源,但根据你的身份和权限,你“被禁止”访问它。前者,是“地址错了”;后者,是“有地址,但没钥匙”。

Q2: 为什么有时候我刷新一下页面,404错误就消失了?

A2: 这通常,暗示着,问题,可能与“时序”或“缓存”有关。例如,你可能,在请求一个刚刚被创建的资源,但因为数据库主从同步的延迟,导致在第一次请求时,资源尚未被同步到你所查询的那台“从库”上。或者,是某个网络层的缓存,返回了一个过时的、“不存在”的响应。

Q3: 我确定我的地址和请求方法都正确,但服务器就是返回404,可能是什么原因?

A3: 此时,应重点排查“服务器端”的原因。首先,与后端开发者确认,该路由,是否真的,已被正确地,部署到了你正在请求的那个环境中?其次,检查,是否有中间件(如认证、权限)提前拦截了你的请求。最后,确认,这是否是一个由业务逻辑(即,你请求的那个具体的数据,在数据库中不存在),所“有意返回”的404

Q4: 作为应用程序接口的设计者,我应该在什么情况下,主动返回404错误?

A4: 当客户端,请求一个“具体的资源实例”(例如,/users/一个不存在的用户ID,或/orders/一个不存在的订单号),而这个实例,在你的业务数据中,确实不存在时,主动地,返回一个404,是一种非常标准、清晰、且符合语义的最佳实践。

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

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

相关文章

医疗信息化自主可控转型的实践探索 —— 以常德二院为例

目录 头雁领航 - 激发医疗新质生产力 核心支撑 - 电科金仓奠定数据底座 生态共建 - 携手护航医疗信创发展 信创产业发展是国家经济数字化转型、提升产业链发展的关键,是科技自立自强的核心基座,其本质是实现中国信息化产业的自主可控。医疗信创作为关…

Gin传参和接收参数的方式

Gin查询参数和接收参数的方式 常用 Gin 绑定方法对比方法用途特点c.Bind()自动识别 Content-Type最通用,根据请求头自动选择绑定方式c.ShouldBindJSON()只绑定 JSON强制使用 JSON 格式,类型明确c.ShouldBindXML()只绑定 XML强制使用 XML 格式c.ShouldBin…

MariaDB/MySQL 客户端工具与服务端配置精要指南

文章目录一、客户端与服务端程序二、用户账号管理三、MySQL 客户端命令3.1 命令类型​3.2 使用模式​3.3 常用选项​3.4 提示符定制​四、mysqladmin管理命令​​五、服务端配置​5.1 配置文件​​​5.2 Socket 通信配置​​六、最佳实践总结免费个人运维知识库,欢迎…

自动化项目日报生成工具测评与选型:如何匹配团队日报管理需求

引言在项目管理场景中,手动撰写日报常面临多重效率瓶颈:任务数据分散在协作群、Excel 表格、项目看板等多个平台,汇总时需反复核对;不同成员日报格式不统一,管理层整合分析耗时;任务进度与日报信息不同步&a…

基于SpringBoot+Vue的吴韵苏香文旅小程序(协同过滤算法、Echarts图形化分析、腾讯地图API、二维码识别)

🎈系统亮点:协同过滤算法、Echarts图形化分析、腾讯地图API、二维码识别;一.系统开发工具与环境搭建1.系统设计开发工具后端使用Java编程语言的Spring boot框架 项目架构:B/S架构 运行环境:win10/win11、jdk17小程序&a…

python numpy.random的基础教程(附opencv 图片转数组、数组转图片)

目录 1.在区间[a,b)随机生成n个整数。 2.在区间[a,b)随机生成n个数。 3.在区间[0,1)生成随机数 4.打乱顺序 5.从指定的列表中选择 NumPy(Numerical Python)是一个开源的科学计算库,专门用于高效处理多维数组(ndarray&#xf…

Vue2.x核心技术与实战(二)

目录 三、Vue2.x:生命周期+工程化开发(组件入门) 3.1 生命周期 3.1.1 生命周期 & 生命周期四个阶段 3.1.2 生命周期钩子 Vue生命周期钩子案例 - 新闻列表 & 输入框自动聚焦 3.2 综合案例:小黑记账清单 3.3 工程化开发入门 3.3.1 工程化开发 & 脚手架Vue …

【鸿蒙心迹】7×24小时极限求生:当Origin_null遇上鸿蒙,我如何用100杯咖啡换一条跨域活路?

文章概要 大家好,我是那个把黑眼圈熬成华为工牌挂绳的倒霉蛋。过去100个夜晚,我在HarmonyOS NEXT的ArkWeb里被Origin:null反复按在地上摩擦——小程序白屏、OPTIONS 400、官方文档沉默三连击。最终,我用C、libcurl、OpenSSL和一堆速溶咖啡&am…

【git】删除一条本地提交的历史commit

在工程中,如果想要删除一条本地提交的历史commit,可以通过droprebase -i HEAD^n的方式。1.情景提交了三条commit,想删掉第二条commit。git logcommit_id_*******1 commit_id_*******2 commit_id_*******32.解决git rebase -i HEAD~2输出&…

软件测试中,JMeter 的作用以及优缺点是什么?

回答重点JMeter 是一款开源的软件测试工具,主要用来对各种软件或服务进行性能测试和负载测试。它可以模拟大量用户同时对服务器、网络或其他资源发起请求,从而测试它们的响应时间、吞吐量等性能指标。优点:1) 开源且免费 &#xf…

STM32存储结构

我们在使用Keil编译程序成功后会,有一行各部分占用内存的提示信息,如下Program Size:Code7492 RO-data556 Rw-data72 ZI-data11688,这是stm32代码编译后的提示我们分析一下这个编译输出:- Code: 7492字节 -> 代码部分(存放在Flash)- RO-da…

手机 浏览器调用摄像头扫描二维码Quagga

注&#xff1a;需用谷歌浏览器才能调用权限1. 引入依赖&#xff1a;npm install ericblade/quagga2<template><el-button color"#188ae2" click"handleScan" class"scan-btn" :disabled"isInitializing || isScanning">{{…

【Oracle篇】伪列之Version Query:全链路追踪行数据变更的所有记录(不仅仅是被修改的最后时间)(第二篇,总共六篇)

&#x1f4ab;《博主主页》&#xff1a;    &#x1f50e; CSDN主页__奈斯DB    &#x1f50e; IF Club社区主页__奈斯、 &#x1f525;《擅长领域》&#xff1a;擅长阿里云AnalyticDB for MySQL(分布式数据仓库)、Oracle、MySQL、Linux、prometheus监控&#xff1b;并对…

代理模式深度解析:从静态代理到 Spring AOP 实现

代理模式是软件开发中一种经典的设计模式&#xff0c;它通过引入 "代理对象" 间接访问目标对象&#xff0c;从而在不修改目标对象代码的前提下&#xff0c;实现功能增强&#xff08;如日志记录、事务管理&#xff09;、权限控制等横切需求。从简单的静态代理到灵活的…

算法 ----- 链式

目录 一 、链式 二 、题目 1、两两相加 &#xff08;1&#xff09;题目 (3) 代码书写 2、两两交换链表中的节点 &#xff08;1&#xff09;题目 &#xff08;2&#xff09; 解题思路 &#xff08;3&#xff09;代码书写 3、重排链表 &#xff08;1&#xff09;题目 …

运维监控prometheus+grafana

目录 一、环境 二、Node_exporter部署 三、Prometheus部署 四、Grafana部署 五、验证、使用 一、环境 系统使用CentOS7虚拟机。 监控三台服务器&#xff1a; 192.168.114.10 Node1 #部署Prometheus、node_exporter、Grafana 192.168.114.20 Node2 …

数字孪生 :提高制造生产力的智能方法

近年来&#xff0c;在先进数字技术深度整合的推动下&#xff0c;制造业经历了深刻变革。数字孪生技术作为其中最具前景的创新之一&#xff0c;正重塑工厂和生产流程的设计、监控和优化方式。该技术的核心在于为物理资产、系统或流程创建虚拟映射。这种虚拟映射实时同步现实世界…

【论文阅读】-《SIGN-OPT: A QUERY-EFFICIENT HARD-LABEL ADVERSARIAL ATTACK》

Sign-OPT: 一种查询高效的硬标签对抗攻击 原文链接&#xff1a;https://arxiv.org/pdf/1909.10773 摘要 我们研究在访问受限情况下评估机器学习系统对抗鲁棒性的最实用问题设置&#xff1a;用于生成对抗样本的硬标签黑盒攻击设置&#xff0c;其中允许有限的模型查询&#xff…

安卓11 12系统修改定制化_____如何去掉 搜狗输入法 首次运行时权限授权弹窗 其他应用可借鉴

有些内置应用或者第三方应用在首次使用时会跳出权限允许弹窗。虽然这个是系统为了用户安全设置的一道检测机制。但无形之中会影响到定制类用户的使用。那么能不能去除这个首次运行的权限弹窗呢。其实也有多方法可参阅解决。 通过博文了解💝💝💝 1💝💝💝-----首次…

双环模型:一个蕴含安全哲学的类设计解析

双环模型&#xff1a;一个蕴含安全哲学的类设计解析 在编程世界中&#xff0c;优秀的类设计不仅能实现功能需求&#xff0c;更能体现开发者对系统本质的理解。本文将深入剖析一个看似简单却蕴含深刻安全哲学的OP类&#xff0c;探讨其双环模型背后的设计思想与实践价值。 类结构…