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

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

—1— 前言 客户端请求API，通常需要通过返回码来判断API返回的结果是否符合预期，以及该如何处理返回的内容等。...API返回码的设计还是要认真对待，毕竟好的返回码设计可以降低沟通成本以及程序的维护成本。...参考HTTP状态码的思路，我们对错误码进行分段。 通过这样的设计，不论是程序还是人都可以非常方便的区分API的返回结果，关键是统一！...—4— 个性化Message 通常我们的Message都是写给工程师看的，但是在不同的场景下，同样的错误，可能需要给用户看到不一样的错误提示。...但是对于API来说，返回的信息又必须是准确的，但用户看到的就必须转译，这个转译的工作调用方可以做，但是通常API提供者来提供个性化的Message能力会更好。

1.4K10

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

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

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

    微信 API 中调用客服消息接口提示错误返回限制

    错误的信息如下：errcode=45015, errmsg=response out of time limit or subscription is canceled rid: 5f8fd8b7-0f8aa1a9...-4b6215a5微信的文档看着这微信不清不楚的文档：微信公众平台在这个文档界面中，有句话：这句话，我估计正常人看的都是云里雾里的。...用土话来说，就是你的客服消息不是你想法就可以发的，微信限制公众号主动发送消息的能力。这 48 小时的定义为：用户 A，发送了一个消息给公众号，公众号会回复消息给客户 A。...用更土的话说，如果你的微信公众号用户在 48 小时内没有和你有过什么互动，你就不能主动发消息给你的用户。解决办法这个问题通常出现在测试阶段，解决办法就是用你的账号关注公众号。...然后那拿你的账号发个消息给你的公众号，那么你就可以调用接口进行消息回复给你的这个客户了。这个解释是不是会清楚点呢？https://www.ossez.com/t/api/14323

    1.9K20

    关于 restful api 路径定义的思考

    关于 restful api 想必不用多说，已经有很多文章都阐述过它的设计原则，但遵循这个原则可以让你的 API 接口更加规范吗？以下是我对 restful api 风格的一些思考。...思考​ 此时不妨思考一个问题，现在以下几个接口，你会怎么去设计 url 路径？...) 就与 article 分离了，并且还占用了 / 下路径。...写到最后​ 在我写这篇文章之前，我尝试抓包看过很多网站的请求 url，见识到各式各样的 url 路径，基本上很难找到遵循 restful api 风格的网站，绝大多数的操作除了获取外用 GET，其余全用...对于复杂的业务，restful api 风格实在过于难以胜任。 如果说变量命名是编程最大的痛苦，那么写接口最大的痛苦我想就是定义 url 路径了。

    47011

    C#常见的文件路径Api

    我们经常有遇到要处理文件路径的需求，那么一般我们常见的有几种： 程序下面的文件 临时目录下的文件 获取程序下面的文件 首先我们创建了实例解决方案： ?...其中调用链是：Main.Shell->FooALibrary->,首先我们将FooAFolder.txt和FooA.txt的文件属性设置生成操作为内容，复制到输出目录为始终复制 那么我们有什么方法获取这两个文件的路径...获取应用程序域的基目录：AppDomain.CurrentDomain.BaseDirectory 获取当前工作目录的完全限定路径：System.Environment.CurrentDirectory...: 获取入口程序集路径：Assembly.GetEntryAssembly().Location，FooALibrary和FooBLibrary的入口都是Main.Shell 获取调用该程序集的程序集路径...Api是非常灵活且准确的 获取临时目录下的文件 我们也经常会遇到需要获取临时目录路径的方式来放置一些程序临时文件，可以用下面方式获取： Console.WriteLine(Path.GetTempPath

    1.7K20

    API网关 APIG，调用已发布的API,错误码0605

    基于API网关的电话号码归属地查询，根据文档操作，最后居然没有成功。 在通过API网关开放电话号码归属地查询服务前，您需要获取登录华为云控制台的用户名和密码，并确保已实名认证此用户。...记录一下APIG的错误码 错误码 错误信息 HTTP状态码 语义 解决方案 APIG.0101 The API does not exist or has not been published in the...environment. 404 API不存在或未发布到环境 检查调用API所使用的域名、请求方法、路径和注册的API是否一致；检查API是否发布，如果发布到非生产环境，检查请求X-Stage头是否为发布的环境名...；检查调用API使用的域名是否已经绑定到API所在的分组。.... 401 APP认证信息错误 检查请求的方法、路径、查询参数、请求体和签名使用的方法、路径、查询参数、请求体是否一致；检查客户端机器时间是否正确。

    2.5K00

    asp.net web api 向客户端返回错误信息

    1使用Http状态码 ASP.NET Web Api框架提供了Http状态码的值，如下图所示。 虽然有这些预定义的状态码，但在实际项目中使用自定状态码结合预定义状态码更有优势。...通过在适当的位置抛出异常 　　throw new HttpResponseException 通过构造函数设置响应或Http状态，来实现向客户端返回相应的执行状态。...自定义状态码的规则为： 1）必须是整数 2）必须小于999 3）600以内的码最好别用 此外消息短语不应很长，如果想更加详细的表达消息，那么也可以使用代码代替消息，但要注意代码不能是三位数字，否则客户端无法正常获得消息内容...2 返回响应中包含错误码和消息短语 使用Web api一般返回序列化后的字符串，将错误码与消息短语也包括在序列化字符串内。但对于使用Odata协议来说，无法这样实现。

    3.2K100

    .net Core API异常信息返回处理

    前言 C#中我们如果操作过程中出现错误一胜败都用throw抛出异常，然后前端接收到后会直接显示出来服务端抛出的异常是什么。...先看一下未修改前的使用效果 我们直接在.net Core的API里设置校验的通讯时间和签名，如果不对直接抛出异常。 C# .net Core的代码 ? Android的代码的显示效果 ?...在android中我们直接看到i当rsp.body()返回的是空，我们就直接捕获到错误的信息显示出来 看看运行的时候效果 ?...可以看到已经出来异常了，但是显示注册失败后面一串XML的信息， 在服务端抛的异常是 ? 或 ? 并不是我们想到的结果，我也看不出来到底是什么原因，错误出现在哪。...可以看到，原来的处理里面通过app.UseExceptionHandler直接就跳转到一个错误页面，所以也造成了接收到的数据是一些XML的数据。我们现在把这里改造一下。

    1.5K20

    08 - AWS DynamoDB batchGet() API 返回 Error

    Node.js 操作DynamoDB中的batchGet() API返回 : 返回 　{ ValidationException: Too many items requested for the...BatchGetItem call｝　错误信息 然后就去重新阅读官网的BatchGetItemAPI文档 也可以参考 错误处理 ?...这不正是遇到的问题，然后查看自己的程序获取的时候确实超过100 Item，如果出现这种问题，怎么处理呢？ 第一种办法 : 很容易想到，数据包拆分，把一次的请求分为两次请求。...第二种办法 : 文档中详细描述到，如果要求检索100个项目，但每个项目的大小为300 KB，则系统将返回52个项目（以便不超过16 MB的限制）。...它还返回一个适当的UnprocessedKeys值，以便您可以获得下一页结果。如果需要，您的应用程序可以包含自己的逻辑，以将结果页面组合到一个数据集中。

    93700

    用API优先和API模拟打破软件交付关键路径上的依赖

    开发团队正在使用 API 模拟来打破关键路径依赖关系，并将串行流程为并行的。...本文探讨了应该在哪些地方使用 API 模拟才能产生最大的影响，并提供了一个模型来估算采用 API 模拟和 API 优先的开发方法所能带来的回报率。...采用 API 模拟只需要一个团队，没有必要让企业全体进行迁移。 开发团队通过 API 模拟打破关键路径依赖，将串行流程变成了并行。...这种架构转变推动了 API 优先开发模式的发展，不同的开发团队通过 API 来定义业务契约。 在实现与特定 API 耦合的特性之前先定义好契约，让团队能够并行开发 API 的生产者和消费者。...5 在关键路径上使用 API 模拟 我们已经看到 API 模拟适用于有两个开发团队相互依赖的场景，对于需要多个团队一起开发新产品或新功能的项目，也同样适用。

    55720

    api网关怎么获取uri路径 api如何处理局部访问失败

    api网关怎么获取uri路径 api网关的作用是多种多样的，获取uri路径是其中之一，那么api网关怎么获取uri路径呢？...在用户通过api网关发送请求访问的时候，api网关会通过内部的系统参数来自动查找用户的目的地，从而进行路径的选择以及放行。...所有的uri地址和uri路径都会提前设置在api网关当中，方便于api网关对于不同身份的用户进行筛选和过滤。...api如何处理局部访问失败 上面了解了api网关怎么获取uri路径，那么api如何处理局部访问失败的情况呢？...获取uri路径是api网关的一个重要核心功能，因此多了解一些相关知识，有助于工作人员以及技术人员对于api网关更好的管理和使用。

    1.8K30

    Windows 下处理文件路径相关的 API 介绍

    处理文件路径信息是经常要用到的字符串处理的手段，应用场景非常的多，不论是 Linux 还是 Windows，在我没接触这一系列函数之前，都是使用一系列字符串处理函数来自己写。...而在 Windows 环境下，系统给我们提供了一系列处理路径相关的 API，我们在需要使用的时候直接调用即可，不但可以避免自己使用字符串处理函数处理时可能造成的各种问题，还可以加快我们编程的速度。...当然如果你还没有使用字符串处理函数自己处理过路径等信息，我强烈建议你先自己尝试学习一下。轮子可不重复制造，但你必须要清楚轮子的制作工艺，否则在出现故障时就不知道如何处理了。...cout #endif #pragma comment(lib, "Shlwapi.lib") int _tmain(int argc, _TCHAR* argv[]) { // 获取程序自身的路径...示例代码中仅仅介绍了一些经常用到的 API，其中还有很多关于路径相关的处理函数。我一时没找到这一系列函数在 MSDN 的页面，大家使用时可以在 VS 中按 F1 跟着找一下其他的函数。

    1.1K20

    前后端分离--MockJS模拟API返回数据

    所以慢慢衍生出以重新的架构模式，在开发阶段前后端约定好Restful API的返回格式，然后后端业务逻辑设计Restful API，前端按照约定好的返回格式协同开发前端并独立完成测试工作。...而刚才也说到了前后端可以协同开发，那前端如果开发完成如何在API还没有完成的情况下机型模拟数据测试呢？所以本篇文章介绍一个前端开发利器---mockJS模拟Restful API 返回数据。...，格式模板按照和后端返回的格式去设计。...，可以发现mock的使用很简单，但是这种集成在前端项目里面存在一个问题：如果后端Restful API实现完毕，前端需要将这部分调用mock的代码注释掉，不然真正的API调用会被mock拦截掉。...，但是多了一个优点在于后端Restful API还未实现，而前端需要测试，我们就可以使用npm run start命令你个启动这个Mock服务获取返回数据进行测试，当后端API实现完成，我们就停止这个Mock

    2.9K20

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

    合理的定义API返回格式 先回到本文的主题，谈一谈数据返回格式。如果您使用的是WebAPI，那么该问题对您来说可能更为重要。...所以开发的时候需要前后两端的人员都遵循某些规则，不然游戏可能就玩不下去了。而API的数据返回格式就是其中的一项。...小丁（前端人员）: 好吧，那我500就不执行操作，然后在界面提醒用户“服务器返回错误”吧。 又过了五分钟.........而后端开发者为了图方便，在api中随意返回结果，只负责业务能够调通就OK，但是却没有任何规范。 前端人员此时心里肯定有一万只草泥马在奔腾，心里默默吐槽： 这个老几写的啥子歪API哦！...前端人员可以将该json进行转换，而“result”代表了业务成功时候的结果，而当“isError”为true的时候，代表本次操作业务上存在错误，错误信息会在“message”中显示。

    1.7K30
    点击加载更多

    相关资讯

    热门标签

    更多标签

    活动推荐

      运营活动

      活动名称
      广告关闭

      腾讯云开发者

      扫码关注腾讯云开发者

      扫码关注腾讯云开发者

      领取腾讯云代金券

      热门产品

      热门推荐

      更多推荐

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

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

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

      领券