三种常见的API设计错误及解决方案

电脑报错:系统资源不足,无法完成 API 调用 在编程过程中,有时候我们可能会遇到一些报错信息,其中一个常见的错误是“系统资源不够无法完成 API”。这个错误提示意味着我们的计算机没有足够的系统资源来执行特定的 API 调用。这可能会导致程序无法正常运行或崩溃。本文将介绍可能导致此错误的原因,并提供一些解决方法。 阅读详情

原文:Three common API design mistakes and how to overcome them
作者:Jennifer Riggins
翻译:Vincent

API已经成为了我们生活中很常见的一部分,那么在API设计过程中有哪些容易犯的错误呢?作者在本文介绍了三种,也给出了相应的解决方案,不妨一起来看一下吧!以下为译文。

作为表单工具Typeform的API领头人,Jason Harmon恰好也与JSON schema同名了,他最近就“哪些因素破坏了生产环境”这个问题在APIdays会议上做了非常积极的讨论。事实上有三个因素。

API解决方案#1:如何让HTTP POST代替GET

由于人们更喜欢使用HTTP GET进行数据检索,因此这就使得HTTP POST变得并不是那么常见了。虽然使用GET会导致URL变得很长,但是由于它们与大多数查询没有什么不同,因此GET已经成为使用HTTP构建过滤查询的默认方法了。(同样值得注意的是,较长的网址往往更容易被Google发现,所以它们对搜索引擎的优化很有帮助。)

但是由于Web应用程序需要使用浏览器,因此使用GET很有可能会出现问题。根据Harmon的说法,由于浏览器(特别是Chrome)特别容易出现缓存,因此如果出现了一个看似重复的GET请求,那么可能会出现一次请求出现两个着陆页。在Typeform上面,Harmonform和他的团队发现由于已经被浏览器标记为重复,实际上页面已经转储过了。

为了解决这个问题,Harmon建议把GET改为POST,因为在HTTP规范中,POST是不会缓存的。

如果请求的API已经在缓存里了,而你又不知道为什么它会在缓存里面,Harmon建议可以从GET入手查找原因:

  1. 尽可能添加POST(请记住,从GET更改为POST可能会导致API合同发生重大更改)
  2. 将?cache_buster=添加到GET(作为维护合同现状的一种方式,如果在开发人员社区中进行重大更改将会非常困难)

这些措施可以有效控制缓存。

API解决方案#2:如何压缩多次轮询的API

像Web应用程序这样的API消费者们一次又一次地调用某个API时,这就被称为轮询API。这种情况通常发生在API消费者期望定期更改某些数据,并得到最新数据时。例如,在Typeform的某些情况下,集成表单的消费者可以定期轮询API,以便获得表单的结果。API消费者可能会使用Zapier,如果平均每5分钟调用一次,那么网络上面会显示大量的调用。

针对这个问题,Harmon提出了这些疑问:

  • 数据集很大吗?
  • 查询的代价高吗?
  • 数据经常变化吗?
  • 客户端多吗?

“我们也提出了一个快速的解决方案,就是设置webhooks,它是一种反向的API。不是他们主动发起请求,而是当某些事情出现以后,我们主动给他们发送POST,”Harmon说。

他把这种请求之间的差异描述为戏剧性的。

“作为webhooks的客户,整个晚上我只想调用一次API,”Harmon说,为了确保不会错过webhook的交付。他接着说,webhook并不是独立存在的,它与API可以很好地兼容,因为它们减少了所需调用的次数。

除了webhook,他还提供了其他选项:

  • 缓存(但是很难实现)
  • 数据库只读权限的镜像

API解决方案#3:如何使用群组调用来利用普通的调用链。

每次构建API时,并不是都需要对所有的东西都进行更新,Harmon以Typeform表单的微服务结构化版本为例说明了这一个问题。在Typeform的某些情况下,立即更新所有内容需要7个单独的API调用,这将导致性能瓶颈。现在正在考虑的一种解决方案是将REST用于graphql驱动的方法。与此同时,Harmon说他们开发了以下的替代方法。

正如上面的图片中看到的,团队将表单分解为一个类似于微服务的结构体,该结构体将某些常见的链式后端活动绑定在一起,以便更有效地服务前端。在响应调用时,服务器端JavaScript (Node.js)中的某一层将处理业务流程,从而形成一个面向前端的(BFF)。这是一种将僵化资源结构转化为优势的方法。

像许多其他情况一样,这种情况关键是要考虑客户端如何执行调用,以及如何使用该工具。Typeform的团队识别了上面看到的模式,他们可以将调用集中到单个链中,比如Form > Design > Background > Image。Harmon说,要关注他所说的N+1调用,比如当客户端可以调用父类时,但是实际上调用了相关条目或者子条目。如果能够识别这样的行为模式,那么就可能会减少API调用的数量,从而提高性能。

Harmon还提到了BFF这种微服务结构体使得新增动作在实时场景中变得容易。不过,他也提出了警告,这是需要提前让用户体验设计师参与进来

站在用户的角度构建API

“构建API时,首先需要考虑的应该是用户应该如何使用。我们称之为API设计,但我们的思考方式更倾向于工程师。“试着跟将要使用API的人产生一些同理心。当真正做到这一点的时候,问题总是可以提前被发现。”

对于开发人员来说这一点很关键,因为这不仅意味着你的客户会继续使用你的API,而且你不活问题和解决问题的能力也会增强,这样才会构建出用户实际上想要使用的产品。

Harmon继续说,这个过程不仅仅是倾听客户,而是要确保在满足客户所有的需求以后,API还能是强大的、安全的和灵活的。

Harmon强调,API设计不仅仅是项目开始时的规范。它也可以解决一些很严重的问题,包括他上面分享的那些“廉价的修复”。所有这些修正首先基于逻辑。

“想想看,在这些电话发生后,会发生什么事情。你怎么读它在你的日志里写的故事?”Harmon问道。

就像所有优秀的客户服务和用户体验创造一样,开发人员的体验可以归结为两件事——倾听你的API消费者是什么,而不是说什么,然后用逻辑来解决他们最大的问题。

App后台开发运维和架构实践学习总结(9)——三种常见的API设计错误及解决方案 作为表单工具Typeform的API领头人,Jason Harmon恰好也与JSON schema同名了,他最近就“哪些因素破坏了生产环境”这个问题在APIdays会议上做了非常积极的讨论。事实上有三个因素。API解决方案#1:如何让HTTP POST代替GET由于人们更喜欢使用HTTP GET进行数据检索,因此这就使得HTTP POST变得并不是那么常见了。虽然使用GET会导致URL变得很长,但 阅读详情

相关推荐

AI虚拟健康系统API设计踩坑实录:接口兼容性+版本管理常见错误

"用户健康数据同步失败率突增至87%!"监控大屏上刺眼的红色警告闪烁着,我的心跳瞬间加速到120次/分——这比屏幕上显示的任何用户心率都要高。作为某AI虚拟健康系统的技术负责人,我深知这个数字背后意味着什么: thousands of用户的实时健康监测数据无法正常上传,AI风险预警系统形同虚设,极端情况下可能延误紧急医疗干预。故障定位很快指向了上周上线的API更新。我们在v2.3版本中优化了健康数据模型,新增了"血氧饱和度趋势"字段,却忽略了对旧版本客户端的兼容处理。

AI智能探索者的博客 1240

百度AI开放平台-API调用返回错误类型大全

错误返回格式 若请求错误,服务器将返回的JSON文本包含以下参数: error_code:错误码。 error_msg:错误描述信息,帮助理解和解决发生的错误。 百度Open API错误码定义: (参考:http://developer.baidu.com/wiki/index.php?title=%E7%99%BE%E5%BA%A6Open_API%E9%94%99%E8%AF%AF...

学习机器学习 7394

拆解人形机器人:核心硬件与驱动系统

本文深入解析人形机器人的核心硬件系统,将其类比为"骨骼+肌肉+神经"的集成体。重点介绍了三大关键组件:驱动单元(无框力矩电机和空心杯电机)、传动单元(谐波减速器和行星滚柱丝杠)以及感知单元(力矩传感器、编码器和IMU)。文章指出一体化关节模组正成为行业趋势,能够实现更紧凑的结构和更高的可靠性。同时分析了硬件价值量分布,强调丝杠、电机等部件是当前技术高地和成本重心。最后指出随着技术进步,机器人价值将更多向"大脑"和"神经"转移。

小明的博客 1531

一线大厂的最佳实践 - API 错误处理

今天的主题是API错误处理 正所谓一入江湖身不由己 至今还在探索中 如今到底如何 1 前言 API 中的错误如何定义,请求过程中出错或请求处理中出错。API 无法解析传递的数据,API 本身有很多问题,甚至格式正确的请求也会进行失败。在这两种情况下,都需要进行分析查找原因。 无论是代码形式的错误还是简单的错误响应,错误代码可能是 API 领域中最有用的诊断元素,错误代码非常有...

u010889990的专栏 2469

易智联LM401模块学习(四)——双串口收发

串口的发送和接受有三种方式,分别是阻塞发送和接收(轮询)、中断方式发送和接收、DMA方式发送和接收。这里我使用阻塞+中断的方式实现双串口通信。简单的串口收发。

weixin_46046597的博客 994

Rockchip开发板FUSB302快充调试避坑指南:从设备树配置到驱动修改全流程

本文详细解析了在Rockchip开发板上调试FUSB302快充功能的全流程,重点涵盖设备树配置、驱动修改及硬件设计避坑指南。针对PD协议协商失败、电流倒灌等常见问题,提供了从软件配置到硬件排查的实战解决方案,帮助嵌入式工程师高效完成快充功能开发。

weixin_28256233的博客 114

微服务API设计的实践与思考总结

随着微服务的越来越流行,越来的越多的公司开始实行微服务架构,相对于单一应用架构,微服务将复杂性拆分并且打散到一个个粒度更加细分的应用中,极大了减少了开发中单个服务的复杂性,开发人员只需要...

Docker的专栏 228

【笔记篇】Davinci Configurator TcpIp模块

AUTOSAR TCP/IP模块配置介绍

weixin_47571898的博客 988

为什么API调用失败?

例如大模型API的标准URL格式为https://api.example.com/v1/chat/completions,其中v1是版本号,chat/completions是接口路径,若遗漏版本号、写错版本号(如v2写成v3),或路径拼写错误,服务端会无法匹配对应的接口资源,返回“404接口不存在”错误。定期检查密钥状态、模型可用性;若模型名称缺失、填写错误,或指定模型不可用,服务端无法找到对应的处理资源,即便URL、API密钥完全正确,也会返回“模型不存在”“模型不可用”等错误,导致调用失败。

wei12366的博客 1273

3. 动手运行第一个 SAP Fiori Elements 应用(ListReport 类型)

这个代理服务器能够自动监听我们 Fiori Elements 应用里向 ES5 Demo 系统发送的 OData 请求,拦截这个请求,并通过 Node.js 代码向 ES5 服务器转发,拿到响应数据后再交还给 Fiori Elements 应用。后者对自己发出的请求被代理这件事情一无所知。本文的任务是,大家按照我的介绍,在本地成功运行笔者准备的这个 Fiori Elements 应用。的错误消息, 说明大家安装的 Node.js 版本没有达到本地运行 Fiori Elements 的最低要求。

2007 年 ~ 2025 年,深耕 SAP 技术 18 年 1675

“华为杯”研究生数学建模竞赛2020年-【华为杯】E题:能见度估计与预测(附获奖论文及python代码实现)

因此,题目要求借助机场的 AMOS 观测数据中的气压、温度、湿度、风速等气象因子,达到 100% 时,空气中的水汽便会凝结成细微的水滴悬浮于空中,使地面水平的能见度下。传统的仪器探测法成本高,覆盖范围小,而基于视频的能见度检测能弥补仪器测量的不足之处,但是预测精度不高,需要进一步改。象条件,空气质量的影响,其中较为关键的影响因子是雾和霾。性过强,激光能见度仪的检测方法更为可信,但是激光能见度仪覆盖的检测范围小,安装。覆盖的交通视频路况数据间接计算得到能见度数值的方法,此方法成本较低,覆盖范围广。

getusushu的博客 2285

CompreFace API请求验证:参数校验与错误处理最佳实践

你是否遇到过这些问题?上传图像返回400错误却不知原因,参数明明正确却提示格式错误,生产环境突然抛出500异常让用户束手无策。CompreFace作为领先的开源人脸识别系统,每天处理数千次API请求,错误的参数校验和不完善的异常处理会直接导致服务可用性下降37%,用户满意度降低52%。本文将系统讲解参数校验的全流程实现与错误处理的架构设计,帮你构建工业级的API防御体系。 读完本文你将掌握: -...

gitblog_00247的博客 1071

DO-297标准详解:IMA系统开发与认证指南

DO-297的前言部分为读者提供了本指南的概述,说明了该标准的编写背景、主要目标、目标受众以及该文件在开发和认证集成模块化航空电子(IMA,Integrated Modular Avionics)系统中的作用。作为现代航空电子架构的重要组成部分,IMA系统大幅度简化了航空电子系统的硬件配置,增加了灵活性并降低了成本。因此,DO-297成为确保IMA系统开发、集成和认证符合适航标准的核心文件。在现代航空领域,系统复杂性逐渐增加,传统上各子系统独立运行的方式已经不适应多任务、多功能的需求。

qq_41854911的博客 1587

浅谈API错误码设计

根据亚马逊官方文档的定义,错误码是通过对错误进行抽象,帮助用户或开发者识别和理解异常性质的代号。错误码与具体错误不是一对一的关系,而是错误类型的一种抽象表示。尽管错误码在系统中只是一个小模块,但它是不可或缺的。错误消息应该帮助用户轻松并快速地理解并解决API 错误,以下是一些设计原则:不要假设用户非常了解你的API。用户可能是客户端开发者、运维人员、IT人员或者APP的普通用户。不要假设用户了解服务实现的细节或熟悉错误上下文(例如日志分析)。

京东科技开发者 1120

【深度学习新浪潮】算力上太空:NVIDIA Space-1 Vera Rubin Module 深度技术解析

NVIDIA Space-1 Vera Rubin Module 不只是一款芯片模组,它是天地一体化 AI 的基础设施底座。它用成熟的 GPU 架构 + 航天级加固,把地面 AI 生态直接平移到太空。下一个 AI 创新战场,不在云端,而在轨道。在轨 LLM星上多模态实时处理卫星自主组网与分布式推理太空算力成为云计算的一级节点参考资料NVIDIA 官方博客:NVIDIA 推出太空计算,将 AI 送入太空轨道GTC 2026 黄仁勋主题演讲。

专注:太空算力、AI infra、异构调度、大模型成本工程 1129

文档:亲测可用解决vnc灰屏,黑屏,鼠标大黑叉情况

主要解决vnc-viewer灰屏,黑屏,鼠标大黑叉等现象,详细见文档。

Panda API 项目常见问题解决方案

Panda API 项目常见问题解决方案 1. 项目基础介绍及主要编程语言 Panda API 是一个简单而强大的 API 文档设计工具,它可以帮助开发者快速构建更好的 API 文档,使得前后端开发更加便捷。项目主要使用 Rust 语言开发,并提供了易于理解的 JSON5 格式的文档编写方式。Panda API 鼓励测试驱动开发(TDD),并简化了前后端之间的开发流程。它是一个免费且开源的项目。 ...

gitblog_00095的博客 1830

贝叶斯统计 [韦来生编]

贝叶斯(Bayes)统计是近几十年来迅速发展起来的数理统计的一个重要分支。贝叶斯方法与经典统计方法的主要不同之处是进行统计推断时除了利用样本信息外,还要利用参数的先验信息,因此可以提高统计推断或统计决策的效果。它在经济、金融、生物、医学、自然科学和社会科学等许多领域具有广泛的应用。贝叶斯方法的研究已渗透到了统计学的几乎所有领域。作者在给中国科学技术大学概率论与数理统计专业本科生开设的“数理统计”课程中有一章专门讲授“贝叶斯方法和统计决策理论”,近十年来也给中国科学技术大学概率统计专业研究生开设过几次“贝叶斯分析”课。本书是在对过去讲稿的内容作了适当的增减和调整的基础上完成的。  本书共分六章。第1章是绪论,介绍了贝叶斯统计的若干基本概念,同时对必要的数理统计的基础知识有重点地作了回顾。第二章介绍了确定先验分布的若干可供选择的方法。第三章介绍了几类常见统计模型参数的后验分布的主要结果和计算方法。第四章和第五章分别介绍了“贝叶斯统计推断”和“贝叶斯统计决策”的内容。第六章介绍了贝叶斯统计计算的若干方法,包括蒙特卡洛方法和马尔可夫链蒙特卡洛(MCMC)方法以及相关统计软件的简介。本书的每一章附右大量的例题和习题,书末附有常用的几个表格和部分习题解答供读者查用。  大约可在54学时内讲授本书的第1章至第六章的主要内容,教师可根据学时需要选讲本书第1章至第六章的部分内容。书中标“*”号的章节可略去不讲,留给读者作为阅读材料。第六章例题中的R代码和部分例题的数据文件等可从作者个人主页下载。  作者在编写本书的过程中参考了J.O.Berger教授的《统计决策论及贝叶斯分析》和茆诗松教授编写的《贝叶斯统计》等书中的一些内容,以及《贝叶斯分析》一书中由张伟平博士编写的有关贝叶斯统计计算的一些内容。在此表示衷心感谢。  本书编写准备过程中,中国科学技术大学统计与金融系的几个研究生帮助完成了本书部分中文的录入和排版,作者对他们的辛勤工作表示真诚的感谢。高等教育出版社为本书的出版给予了大力支持。在此一并致谢。

云API错误码的设计规则

其实大部分的异常情况,我的建议是直接抛出错误。不要吞掉异常!!!少部分带有逻辑的情况,可能需要按照返回错误值的方式来处理。

sdgfafg_25的博客 1415

jre9下载 jdk9

(Java SE Runtime Environment 9.0) 9.0u175 官方最新版 【x86|x64】

jdk-8u144-linux-x64.tar.gz.

该资源为搭建Linux系统Java环境用,资源的后缀为tar.gz格式的压缩包

API对接的常见问题与解决方案

API门户可提供API文档管理,建立 API 开发者双向沟通管道. 进而形成完善的 API 管理机制。确保理API提供方的认证机制(如API Key、JWT、OAuth),并按照文档正确实现。管理层面:API提供方可能采用新的鉴权机制,但未公告API用户,导致授权失败。综合上述API对接的挑战,建议可构建 API 网关提供 API 安全防护,在对接前,要求API提供方提供完整的API文档,并验证示例代码是否可用。关注API提供方公告,提前测试新版本API,避免突然升级导致业务异常。

YisquareTech的博客 1727

axum问题排查:常见错误与解决方案

在使用axum构建Web应用时,开发者常常会遇到各种难以调试的错误。从令人困惑的类型错误到难以捉摸的运行时异常,这些问题不仅耗费时间,还可能阻碍项目进度。本文将系统梳理axum开发中的常见错误类型,提供清晰的诊断思路和解决方案,并通过丰富的代码示例和流程图帮助你快速定位并解决问题。读完本文,你将能够: - 识别并修复90%的axum常见错误 - 掌握处理程序类型错误的调试技巧 - 理解并自定义提...

gitblog_01063的博客 1248

浅谈三种API设计风格RPC、REST、GraphQL

前言 Web API设计其实是一个挺重要的设计话题,许多公司都会有公司层面的Web API设计规范,几乎所有的项目在详细设计阶段都会进行API设计,项目开发后都会有一份API文档供测试和联调。本文尝试根据自己的理解总结一下目前常见的四种API设计风格以及设计考虑点。 正文 1. RPC 这是最常见的方式,RPC说的是本地调用远程的方法,面向的...

陌上轩客 8709

API对接过程中遇到错误怎么办?

API 对接的挑战主要在文档质量、兼容性、性能、数据一致性等方面。前期评估:开发前先使用 API 调试工具(如 Postman)检测 API 功能是否完善。中期设计:开发客户端的程式时,实现重试、降级、缓存等机制。后期监控:实时跟踪 API 可用性、性能,错误率及提供告警机制。希望这些信息能帮助你顺利解决 API 对接过程中遇到的问题。

wanbangAPI01的博客 1943

服务API设计之——API错误返回规范

API错误返回规范 禁止通过抛异常形式返回API业务错误 API禁止抛Checked异常,即业务处理上的参数错误、逻辑错误、业务错误等禁止通过抛异常形式返回,应用Response#code, message表达业务错误。 注:不要逼调用方到处写try{}catch()...

chenggedian7759的博客 1747

OpenAPI-Specification错误码设计:构建清晰的API错误体系

你是否曾面对这样的困境:调用API时收到模糊的"500 Internal Server Error"却无从排查?客户端因缺少错误上下文导致用户投诉?不同API端点返回格式混乱的错误信息增加开发成本?本文将系统讲解如何基于OpenAPI-Specification(开放API规范,简称OAS)构建结构化错误码体系,通过标准化设计消除这些痛点。 读完本文你将掌握: - 符合OAS规范的错误码分层设计...

gitblog_00576的博客 1076

API错误码设计详解

文章摘要 本文系统讲解了API错误码的设计与实践,涵盖前后端协作、微服务治理全流程。核心要点包括: 分层设计:HTTP状态码处理协议层错误,业务code表达应用语义(成功code=0,失败code≠0) 统一响应:推荐JSON信封包含code/message/data/traceId,禁止暴露内部信息 编码规范:数字分段或字符串命名,确保唯一性、可读性、可扩展性 实现策略:后端全局异常分层处理,前端基于code分支而非message匹配

REDcker的博客 842

Memos问题排查:常见错误与解决方案汇总

作为一款开源轻量级笔记服务(Note-taking Service),Memos以其简洁设计和高效性能受到众多用户青睐。然而在实际使用中,无论是Docker部署失败、数据库连接错误还是API调用异常,都可能影响你的使用体验。本文汇总了20+常见错误场景,提供系统化排查流程和解决方案,帮你快速定位问题根源。读完本文,你将掌握: - 9类核心错误的诊断方法 - Docker部署与数据持久化方案 - ...

gitblog_00167的博客 1342
上一篇: 别人在忙挖矿,京东架构师却悄悄用区块链搞了件大事!
下一篇: 应用广泛的语言ECMAScript 2018来了,新特性都在这里
csdn研发技术
博客等级 码龄9年 1381粉丝 90原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值