首页
学习
活动
专区
圈层
工具
发布

如何设计API返回码(错误码)?

一、前言 客户端请求API,通常需要通过返回码来判断API返回的结果是否符合预期,以及该如何处理返回的内容等 相信很多同学都吃过返回码定义混乱的亏,有的API用返回码是int类型,有的是string类型...,有的用0表示成功,又有的用1表示成功,还有用”true”表示成功,碰上这种事情,只能说:头疼 API返回码的设计还是要认真对待,毕竟好的返回码设计可以降低沟通成本以及程序的维护成本 二、HTTP状态码参考...,不论是程序还是人都可以非常方便的区分API的返回结果,关键是统一!...但是对于API来说,返回的信息又必须是准确的,但用户看到的就必须转译,这个转译的工作调用方可以做,但是通常API提供者来提供个性化的Message能力会更好 我们可以把转译的消息配置到数据库,并缓存到Redis...我们可以根据单位时间内99999的数量来做API的异常告警 我们可以根据Code的返回饼图,帮助我们发现系统、业务流程中的问题 等等 ---- 总之,好的返回码设计,可以帮助我们提高沟通效率,降低代码的维护成本

7.5K30

如何设计API返回码(错误码)?

—1— 前言 客户端请求API,通常需要通过返回码来判断API返回的结果是否符合预期,以及该如何处理返回的内容等。...API返回码的设计还是要认真对待,毕竟好的返回码设计可以降低沟通成本以及程序的维护成本。...参考HTTP状态码的思路,我们对错误码进行分段。 通过这样的设计,不论是程序还是人都可以非常方便的区分API的返回结果,关键是统一!...但是对于API来说,返回的信息又必须是准确的,但用户看到的就必须转译,这个转译的工作调用方可以做,但是通常API提供者来提供个性化的Message能力会更好。...—5— 返回信息的统一处理 有了统一的code,我们就可以通过Nginx或者APM工具统计API请求Code数量及分布信息。 我们可以根据单位时间内99999的数量来做API的异常告警。

1.3K10
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    基于MinerU的PDF解析API

    基于MinerU的PDF解析A - MinerU的GPU镜像构建 - 基于FastAPI的PDF解析接口 支持一键启动,已经打包到镜像中,自带模型权重,支持GPU推理加速,GPU速度相比CPU每页解析要快几十倍不等...主要功能 删除页眉、页脚、脚注、页码等元素,保持语义连贯 对多栏输出符合人类阅读顺序的文本 保留原文档的结构,包括标题、段落、列表等 提取图像、图片标题、表格、表格标题 自动识别文档中的公式并将公式转换成...latex 自动识别文档中的表格并将表格转换成latex 乱码PDF自动检测并启用OCR 支持CPU和GPU环境 支持windows/linux/mac平台 具体原理 请见PDF-Extract-Kit...PDF文档中包含大量知识信息,然而提取高质量的PDF内容并非易事。...developer/article/2469868 启动日志: 输入参数: 访问地址: http://localhost:8888/docs http://127.0.01:8888/docs 解析效果: 返回内容字段包括

    1.6K10

    如何使用 Java 将 PDF 转换为 Word - 免费 PDF 转换器 API

    在本文中,您将学习如何使用 ComPDFKit 的PDF转Word API在 Java 应用程序中将 PDF 转换为 Word 。使用我们的 API,您每月最多可以免费转换1000 个 PDF 文件。...如何将 PDF 转换为 Word ComPDFKit 支持通过简单的 API 请求将 PDF 准确地转换为 Word,保留文本、页面布局、列、格式、图形等。...它还支持识别和提取 PDF 文件中的突出显示、下划线、波浪线和删除线,并在将其转换为 Word 后保留这些注释功能。此外,即使您的 PDF 包含超链接,它也能够在转换后保持链接正常工作。...创建帐户后,您将看到以下页面,其中显示了您的计划详细信息概述。正如您在仪表板上看到的,您每月可以处理 1000 份文档,并且您将能够访问我们所有的 PDF API 工具。...第 2 步 - 获取用于身份验证的 API 密钥验证电子邮件后,您可以从仪表板获取 API 密钥。在左侧菜单中,单击 API 密钥。

    1.5K10

    后台只返回编号,前端如何解析成对应的文字显示

    页面效果 image.png 后台返回的数据类型 'type': 'Bi,Ea', 需要做的处理 后台返回的不同的字符串编号,每个编号对应不同的文字描述,比如说 Bi 对应消息推送应用。...前端需要对后台返回的字符串做识别判断 // template // 模板中不能直接遍历后台返回的type属性,而是绑定和遍历处理过后的 newType 属性 的编码和对应文字 const codeArr = item1.type.split(',') //把每一行的type属性通过split分解成一个数组 得到['Bi','Ea...if (item2 === item3.code) { // 如果 item2 的编号和 item3的code属性相等 item1.newType.push...({ //就把item2 的编号 和 item3的value 赋值给每一行的新增加item1属性 code: item2, value

    1K20

    如何设计 API 接口,实现统一格式返回?

    文章目录: 前后端接口交互 接口返回值约定 返回值规范 正确返回 错误返回 统一定义错误码 错误码规范 Controller 层如何用?...接口返回值约定 返回值规范 设置返回的 HTTP 响应状态码; 发生错误时,需设置 Response Body 的错误码和描述信息; 正确返回 HTTP 响应状态码,设置成 200,Response Body...结构为返回的数据结构。...问题思考 1、提供对外接口时,如何进行安全的签名验证? 2、接口的幂等性如何设计? 3、如何统一对返回数据进行敏感数据脱敏? 4、如何设计接口日志,便于接口联调时快速进行错误定位?...5、关于接口文档,如何进行自动生成?听说过 swagger 还不知道如何使用? 如果你对以上问题有疑惑或拿捏不准,快来我的星球交流讨论吧。

    1.6K10

    如何设计API接口,实现统一格式返回?

    因为老顾这篇主要介绍的是API接口,所以我们聚焦点,其他的模块小伙伴们自行去补充。...针对URL路径的restful风格,以及传入参数的公共请求头的要求(如:app_version,api_version,device等),老顾这里就不介绍了,小伙伴们可以自行去了解,也比较简单。...老顾注重介绍一下后端服务器如何实现把数据返回给前端?...Message 这个字段相对理解比较简单,就是发生错误时,如何友好的进行提示。一般的设计是和code状态码一起设计,如 ? 再在枚举中定义,状态码 ? 状态码和信息就会一一对应,比较好维护。...Data 返回数据体,JSON格式,根据不同的业务又不同的JSON体。 我们要设计一个返回体类Result ?

    2.4K80

    如何设计 API 接口,实现统一格式返回?

    因为这篇主要介绍的是API接口,所以我们聚焦点,其他的模块小伙伴们自行去补充。...针对URL路径的restful风格,以及传入参数的公共请求头的要求(如:app_version,api_version,device等),这里就不介绍了,小伙伴们可以自行去了解,也比较简单。...后端服务器如何实现把数据返回给前端?...Message 这个字段相对理解比较简单,就是发生错误时,如何友好的进行提示。一般的设计是和code状态码一起设计,如 ? 再在枚举中定义,状态码 ? 状态码和信息就会一一对应,比较好维护。...Data 返回数据体,JSON格式,根据不同的业务又不同的JSON体。 我们要设计一个返回体类Result ?

    1.8K40

    如何设计API接口,实现统一格式返回?

    因为老顾这篇主要介绍的是API接口,所以我们聚焦点,其他的模块小伙伴们自行去补充。...针对URL路径的restful风格,以及传入参数的公共请求头的要求(如:app_version,api_version,device等),老顾这里就不介绍了,小伙伴们可以自行去了解,也比较简单。...老顾注重介绍一下后端服务器如何实现把数据返回给前端?...Message 这个字段相对理解比较简单,就是发生错误时,如何友好的进行提示。一般的设计是和code状态码一起设计,如 ? 再在枚举中定义,状态码 ? 状态码和信息就会一一对应,比较好维护。...Data 返回数据体,JSON格式,根据不同的业务又不同的JSON体。 我们要设计一个返回体类Result ?

    65410

    如何设计 API 接口,实现统一格式返回?

    因为老顾这篇主要介绍的是API接口,所以我们聚焦点,其他的模块小伙伴们自行去补充。...针对URL路径的restful风格,以及传入参数的公共请求头的要求(如:app_version,api_version,device等),老顾这里就不介绍了,小伙伴们可以自行去了解,也比较简单。...后端服务器如何实现把数据返回给前端?...Message 这个字段相对理解比较简单,就是发生错误时,如何友好的进行提示。一般的设计是和code状态码一起设计,如 ? 再在枚举中定义,状态码 ? 状态码和信息就会一一对应,比较好维护。...Data 返回数据体,JSON格式,根据不同的业务又不同的JSON体。 我们要设计一个返回体类Result ?

    49030

    如何使用Vue.js和Axios来显示API中的数据

    API经常公开其他开发人员可以在自己的应用程序中使用的数据,而不必担心数据库或编程语言的差异。 开发人员经常从API返回数据,该数据返回JSON格式的数据,并将其集成到前端应用程序中。...有关使用API​​的综合教程,请参阅如何在Python3中使用Web API 。 虽然它是为Python编写的,但它仍将帮助您理解使用API​​的核心概念。...它也类似于我们从cryptocompare API获得的数据。 保存文件。 现在让我们修改我们的标记以更加程序化的方式处理数据。...第4步 - 从API获取数据 现在是时候用来自cryptocompare API的实时数据替换我们的模拟数据,以美元和欧元的形式在网页上显示比特币和以太坊的价格。...您学习了如何在页面上显示数据,迭代结果以及将静态数据替换为API的结果。 既然您已经理解了基础知识,那么您可以将其他功能添加到您的应用程序中。

    11.8K20

    如何使用php调用api接口,获得返回json字符的指定字段数据

    如何使用php调用api接口,获得返回json字符的指定字段数据 今天试着用php调用远程接口,获取调用接口后的数据,将其记录下来,方便日后调用。...开始调用 逻辑: 先合并出需要调用的接口以及参数 然后用php中file_get_contents()函数,获取接口返回的所有内容。...最后再通过json_decode,将获取到的内容进行json解码,然后进行输出,得到想要的结果。(这里调用接口,获得百度域名的备案主体的信息)。...下面是输出的结果: 下面是直接访问上方接口返回的内容 最后,将上面的示例代码放出来。 需要的可以免登录,下方评论拿走即可! 本文共 220 个字数,平均阅读时长 ≈ 1分钟

    9.9K30

    【5min+】美化API,包装AspNetCore的返回结果

    合理的定义API返回格式 先回到本文的主题,谈一谈数据返回格式。如果您使用的是WebAPI,那么该问题对您来说可能更为重要。...小丁(前端人员): 那现在是什么情况,返回的是200,但是我又没有办法处理这个对象,导致界面显示了奇奇怪怪的东西。...这样当大家都遵循该显示规范的时候,就不会造成前端人员不知道如何反序列结果,导致各种undefined或者null的错误。同时也避免了各种不必要的沟通成本。...从图中我们就可以看出,我们通常在处理一个文件的时候,就不是返回ObjectResult了,而是返回FileResult。还有其它没有返回值的情况,或者身份验证的情况。...这样我们就从一个Action返回结果到了我们从POSTMan中看到的结果。 返回结果包装 在有了上面的知识基础之后,我们就可以考虑怎么样来实现将返回的结果进行自动包装。

    1.6K30
    领券