文档建议反馈控制台
首页
学习
活动
专区
圈层
工具
MCP广场
文章/答案/技术大牛
发布

如何设计API返回码（错误码）？

—1— 前言 客户端请求API，通常需要通过返回码来判断API返回的结果是否符合预期，以及该如何处理返回的内容等。...API返回码的设计还是要认真对待，毕竟好的返回码设计可以降低沟通成本以及程序的维护成本。...—3— 参数约定 虽说是返回码设计，但是只有code是不行的，还要有对应的message，让人可以看懂。 参考HTTP状态码的思路，我们对错误码进行分段。...通过这样的设计，不论是程序还是人都可以非常方便的区分API的返回结果，关键是统一！...—4— 个性化Message 通常我们的Message都是写给工程师看的，但是在不同的场景下，同样的错误，可能需要给用户看到不一样的错误提示。

1.4K10

如何设计API返回码（错误码）？

一、前言 客户端请求API，通常需要通过返回码来判断API返回的结果是否符合预期，以及该如何处理返回的内容等 相信很多同学都吃过返回码定义混乱的亏，有的API用返回码是int类型，有的是string类型...，有的用0表示成功，又有的用1表示成功，还有用”true”表示成功，碰上这种事情，只能说：头疼 API返回码的设计还是要认真对待，毕竟好的返回码设计可以降低沟通成本以及程序的维护成本 二、HTTP状态码参考...，我们对错误码进行分段 返回码值 说明 0 成功 99999 系统发生未知异常 10000-19999 参数校验错误 20000-29999 A步骤执行失败 30000-39999 B步骤执行失败 通过这样的设计...，不论是程序还是人都可以非常方便的区分API的返回结果，关键是统一！...但是对于API来说，返回的信息又必须是准确的，但用户看到的就必须转译，这个转译的工作调用方可以做，但是通常API提供者来提供个性化的Message能力会更好 我们可以把转译的消息配置到数据库，并缓存到Redis

7.6K30
    • 您找到你想要的搜索结果了吗？
    是的
    没有找到

    Docusign通过新平台扩展其开发者社区

    Docusign 过去 21 年的成功建立在开发者使用公司 API 创建自定义集成的基础上。凭借其新平台，开发者现在有更多机会构建扩展和插件，从而提高定制和集成能力。...开发者是商业协议不可或缺的一部分 仅在过去 12 个月中，Docusign 用户就提交了超过 12 亿个签名，其中超过 5 亿个签名由开发者构建的 API 集成提供支持。...协议 API: Docusign 现有 API 产品组合（电子签名、Web 表单、管理）的扩展，新增了协议 API，可将智能协议管理平台功能嵌入到外部产品体验中，使开发者能够构建超越电子签名的集成。...这些新的 API 包括 Maestro API（测试版），它使开发者能够以编程方式将工作流与他们的系统集成，从而实现协议流程的高级自动化和定制；以及 Navigator API（也是测试版），它有助于查询和集成结构化协议数据...数字协议的其他方面 数字协议的某些方面一开始可能并不明显，但随着时间的推移会逐渐显现出来。

    96010

    金融科技合作伙伴关系简化银行数据集成

    与Docusign合作，使Glyue可在Docusign的开发者控制台中使用，这代表着将该应用程序交付给全天候需要此服务的金融机构的重要一步。...Sandbox联合创始人兼首席执行官在11月的首届Docusign Discover活动上讨论了与Docusign的合作关系。...与Docusign的合作关系 Glyue应用程序是Docusign智能协议管理平台中的一个关键组件，尤其是在其Maestro工作流程构建器中。...使用Glyue，银行可以自动在其核心系统中更新此信息，从而无需手动数据输入并减少错误。”...人工智能使我们能够利用我们庞大的API文档和预构建集成库来创建更智能和自动化的解决方案。我们设想未来人工智能可以生成集成逻辑，使非程序员更容易构建和部署集成。”

    62810

    【技术干货】Attacking SOAP API

    SOAP 内置了错误处理逻辑，因此相比于REST API更加可靠。...漏洞案例：在识别到SOAP API之后，通过对消息体中的参数进行简单的sql注入判断，发现数据库报错信息使用条件语句继续进行判断' or 1=1 ---qqq ’ or 1=2 ---qqq从返回的结果判断该参数部分存在...标签解析错误从而报错。...成功解析并触发弹框用户名枚举在SOAP API中，同样由于相关业务设计的疏忽，可能也会存在一些业务性漏洞，比如：用户名枚举、验证码爆破等等漏洞案例：在SOAP API请求中对username参数进行枚举当存在用户时返回...：User Exists当不存在用户时返回：User Not Found命令执行SOAP API的命令执行漏洞其实也输入SOAP注入的一种，通过对相关参数部分植入命令执行payload，由于相关验证机制不全或者被绕过

    1.1K20

    【webservice】Java JAX-WS和JAX-RS webservice「建议收藏」

    webservice请求处理器用于解析收到的soap请求，调用webservice服务，获取soap应答。web服务器得到soap应答后，再通过http应答的方式返回给客户端。...REST风格的webservice不采用soap传输，直接采用http传输，可以返回xml或json。...我是用普通的请求soap协议webservice服务端的代码去调用这个服务，http响应码返回500，和如下错误信息 Only SOAP 1.1 or SOAP 1.2 messages...are supported in the system 从报错信息我们可以大概猜测出，错误出在soap调用版本上。...之后我又尝试使用请求rest协议webservice服务端的代码去调用，依旧没有成功，这次没有http响应码和任何错误信息的返回，日志显示“read timeout”。

    5.5K20

    API架构风格对比：SOAP vs REST vs GraphQL vs RPC

    一个SOAP消息包含： 每个消息的开始和结束都要包含一个信封标签 包含请求或响应的消息体 标头(如果消息必须确定某些具体要求或额外要求) 请求过程中的错误信息 ?...内置错误处理：SOAP API规范可以返回Retry XML消息(携带错误码和错误解释) 大量安全扩展：集成了WS-Security，SOAP符合企业级事务质量。...GraphQL：仅请求需要的数据 它需要多次调用REST API才能返回所需的内容。 因此，GraphQL被认为是一种改变API规则的风格。 GraphQL 的语法描述了如何发起精确的数据请求。...GraphQL如何工作 一开始，GraphQL会创建一个schema(模式)，它描述了在一个GraphQL API中的所有请求以及这些请求返回的所有types。...详细的错误消息：与SOAP类似，GraphQL提供了详细的错误信息，错误信息包括所有的解析器以及特定的查询错误。 灵活的权限：GraphQL允许在暴露特定的功能的同时保留隐私信息。

    3.7K11

    API 架构风格抉择：SOAP、REST、GraphQL 和 RPC 的特性、优势与局限

    SOAP 消息由以下部分组成： 每封邮件开头和结尾的信封标签， 包含请求或响应的主体 如果消息必须确定任何细节或额外要求，则需要标头，以及 错误通知，告知在请求处理过程中可能发生的任何错误。...内置的创建基于 Web 的服务功能允许 SOAP 处理通信，并使响应与语言和平台无关。 绑定多种传输协议。SOAP在传输协议方面非常灵活，可以适应多种场景。 内置错误处理。...SOAP API 规范允许返回带有错误代码及其解释的“重试”XML 消息。 一系列安全扩展。SOAP与 WS-Security 协议集成，满足企业级事务质量要求。...向服务器发送一个大规模查询后，API 将返回一个 JSON 响应，其数据结构与我们请求的数据完全一致。...与 SOAP 类似，GraphQL 提供发生的错误的详细信息。其错误消息包含所有解析器，并指向出错的确切查询部分。 灵活的权限。GraphQL允许选择性地公开某些函数，同时保留隐私信息。

    1.1K10

    Salesforce Integration 概览(五) Remote Call-In（远程操作 外部->salesforce）

    •事务/提交行为默认情况下，如果某些记录标记有错误，则每个API调用都允许部分成功。这可以更改为“全部或无”行为，如果发生任何错误，将回滚所有结果。不可能跨多个API调用跨事务。...请求的所有响应主体和HTTP状态都在单个响应主体中返回。整个请求都算作一个符合API限制的调用。...Apex REST服务与SOAP不同，它不需要客户机使用服务定义/约定（WSDL）并生成客户机存根。远程系统只需要能够形成HTTP请求并处理返回的结果（XML或JSON）。...针对 Error Handling以及 Recovery官方建议如下： 错误处理—所有远程调入方法、标准或自定义API都要求远程系统处理任何后续错误，例如超时和重试管理。...虽然可以在Salesforce中管理其中一些情况（特别是在定制SOAP和REST服务的情况下），但我们建议远程系统（或中间件）管理错误处理和幂等设计。

    3.8K20

    REST vs RPC - RESTful究竟是什么？

    返回的状态码是手工编码的，也是你定义的一部分。 -相反，REST API将问题域中的各种实体建模为资源，并使用HTTP谓词来表示针对这些资源的事务 -  POST创建，PUT更新和GET读取。...重点 可以建模为客户端可以使用或采取行动的资源，不是客户端和服务器之间通信的实现细节 资源-----返回一个资源对象 正确返回 { "login":true } 错误返回 { true } 核心...RESTful API的具体实现则是 资源---url本身就是名词，而不含有动词 错误 /getLoginInfo 正确 /loginInfo 使用或采取行动----略 不是客户端和服务器之间通信的实现细节...---使用http的状态码来描述请求状态而不是自定义code 例如这种常见的返回对象是不符合RESTful API的 { 　　code：001 　　message：密码错误 　　data：{ 　　}...但是联系下前后文，想到了RPC和SOAP突然就懂了，，， RPC不说，文中的例子说的很清楚，说下SOAP 现在可能没啥人了解过SOAP这时代之泪，简单的说就是HTTP+XML,通过特定标签获取数据

    1.7K50

    聊一聊WebService接口测试方法与工具

    测试WebService接口（特别是基于SOAP协议的WebService）与测试RESTful API在核心目标上类似（功能、性能、安全、可靠性），但由于协议（SOAP/XML vs HTTP/JSON...输出验证： 检查响应XML是否符合XSD/Schema定义，数据是否正确，状态码/错误信息是否准确。业务逻辑验证： 确保接口按照业务规则处理请求并返回预期结果。...异常测试： 强制触发服务端异常（如超时、数据库连接失败、内部错误），验证SOAP Fault是否被正确生成和返回。...Postman： 现代API测试首选，对SOAP支持较好。可以发送SOAP请求（需手动或通过WSDL导入生成请求体）。强大的脚本（Pre-request Script, Tests）支持断言和自动化。...检查：HTTP状态码： 通常200 OK表示成功（即使业务逻辑出错，SOAP协议层面成功也会返回200）。SOAP结构： 响应是否是有效的SOAP消息（有Envelope, Body）。

    85320

    API 架构选哪种？SOAP、REST、GraphQL 与 RPC 全方位对比分析

    SOAP 的消息由这些部件组成： 一个信封标签：用于开始和结束每条消息 包含请求或响应的正文 一个标头：用于表示消息是否由某些规范或额外要求的来确认 故障通知：包含了可能在请求处理过程只能够发生的任何错误...SOAP 在适用于多种场景的传输协议方面是十分灵活的。 内置错误处理。SOAP API 规范允许返回带有错误码及其说明的的 XML 重试消息。 一系列的安全拓展。...4GraphQL：仅请求所需要的数据 REST API 需要被多次调用才能返回所需要的资源。所以，GraphQL 被发明了，并改变了这一切游戏的规则。...API 向服务端发送一个庞大的查询，该 API 返回一个仅包含我们所需数据的 JSON 响应。...详细的错误消息：GraphQL 以类似于 SOAP 的方式提供所发生错误的详细信息。它的错误消息包括所有解析器，并指向确切的发生故障时的查询部分。

    27420

    4种主流的API架构风格对比

    SOAP 的消息由这些部件组成： 一个信封标签：用于开始和结束每条消息 包含请求或响应的正文 一个标头：用于表示消息是否由某些规范或额外要求的来确认 故障通知：包含了可能在请求处理过程只能够发生的任何错误...内置创建 Web 服务的功能使得 SOAP 能够处理消息通信的同时发送独立于语言和平台响应。 绑定到各种协议。SOAP 在适用于多种场景的传输协议方面是十分灵活的。 内置错误处理。...SOAP API 规范允许返回带有错误码及其说明的的 XML 重试消息。 一系列的安全拓展。SOAP 与 ES-Security 集成，因此 SOAP 可满足企业级事务要求。...API 向服务端发送一个庞大的查询，该 API 返回一个仅包含我们所需数据的 JSON 响应。 ?...详细的错误消息：GraphQL 以类似于 SOAP 的方式提供所发生错误的详细信息。它的错误消息包括所有解析器，并指向确切的发生故障时的查询部分。

    2.9K20

    4种主流的API架构风格对比

    SOAP 的消息由这些部件组成： · 一个信封标签：用于开始和结束每条消息 · 包含请求或响应的正文 · 一个标头：用于表示消息是否由某些规范或额外要求的来确认 · 故障通知：包含了可能在请求处理过程只能够发生的任何错误...SOAP 在适用于多种场景的传输协议方面是十分灵活的。 内置错误处理。SOAP API 规范允许返回带有错误码及其说明的的 XML 重试消息。 一系列的安全拓展。...GraphQL：仅请求所需要的数据 REST API 需要被多次调用才能返回所需要的资源。所以，GraphQL 被发明了，并改变了这一切游戏的规则。...API 向服务端发送一个庞大的查询，该 API 返回一个仅包含我们所需数据的 JSON 响应。...详细的错误消息：GraphQL 以类似于 SOAP 的方式提供所发生错误的详细信息。它的错误消息包括所有解析器，并指向确切的发生故障时的查询部分。

    2.9K30

    技术专题：API资产识别大揭秘（一）

    这就导致当前大多数自动识别工具的结果将URL错误地识别为API。实际上URL是统一资源定位符，是对可以从互联网上得到资源的位置和访问方法的一种简单表示。用于访问特定的网页、图像或文件。...正确返回{ "data": { ... }}# 执行时发生错误{ "errors": [ ... ]}使用场景：比较复杂的数据查询和获取、需要从多个平台进行数据查询并集成、前后端分离模式下，需灵活开发...统一返回数据格式：常用的返回数据格式有 JSON 和 XML。请求和响应的数据格式统一。...，也就是说，GraphQL API存在一个类似于JSON的特殊格式，且请求中的参数和返回结果一一对应。...（必须元素）Fault: 如果在处理过程中出现问题，则用于错误消息和状态信息。（可选元素）并且在请求正文中必须包含Envelope、Body元素以及相关内容。

    2K21

    【RESTful】RESTful API 接口设计规范 | 示例

    503 Server Unavailable // 服务器当前不能处理客户端的请求 RESTful 架构与其他架构的区别 API 的开发方式不止一种，另一种比较流行的开发方式是SOAP WebService...对比 效率与易用性：SOAP由于各种需求不断扩充其本身协议的内容，导致在SOAP处理方面的性能有所下降。同时在易用性方面以及学习成本上也有所增加。...例如创建用户资源时需要用户名、密码，而前端只提供用户名字段，那么就要返回一个422 状态码，并返回错误信息：”密码不能为空“ 500 INTERNAL SERVER ERROR 服务器内部错误，此时服务端无法处理任何请求...错误处理 如果状态码是4xx或5xx,就应该向用户返回出错信息。...一般而言，返回的信息中将error作为键名，出错信息作为键值即可，例如： { "error":"参数错误" } 返回结果 针对不同操作（如GET,POST），服务器向用户返回的结果应该符合以下规范：

    3.1K20
    点击加载更多

    相关资讯

    热门标签

    更多标签

    活动推荐

      运营活动

      活动名称
      广告关闭

      腾讯云开发者

      扫码关注腾讯云开发者

      扫码关注腾讯云开发者

      领取腾讯云代金券

      热门产品

      热门推荐

      更多推荐

      Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有

      深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 粤公网安备44030502008569号

      腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号

      领券