API错误码设计

最新推荐文章于 2023-12-22 08:59:15 发布
最新推荐文章于 2023-12-22 08:59:15 发布
阅读量326 收藏 2
点赞数
分类专栏： swagger REST java 文章标签： java https restful
原文链接：https://www.zhihu.com/question/24091286
版权
java 同时被 3 个专栏收录
32 篇文章 0 订阅
订阅专栏
swagger
3 篇文章 0 订阅
订阅专栏
REST
3 篇文章 0 订阅
订阅专栏

错误码组成

应用标识+功能域+错误类型+错误编码 
错误码位数：8位
错误码示例：I102P001
使用规范：只增不改，避免混乱

应用标识(2位字母和数字)

AXXX平台：A1 
AXXX平台：A2 
VXXX平台：V1
ZXXX平台：Z1

功能域(2位数字)

未分类：00 
X1相关：01
X2相关：02
X3相关：03

错误类型(1位字母)

参数错误：P
业务错误：B
系统错误：S
网络错误：N
数据库错误：D
缓存错误：C
RPC错误：R
文件IO错误：F
其他错误：O

错误编码(3位数字)

自增即可
草莓盼盼是胖胖
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
面试题：如何设计API返回码（错误码）？
xuxu96
01-18 567
客户端请求 API，通常需要通过返回码来判断 API 返回的结果是否符合预期，以及该如何处理返回的内容等相信很多同学都吃过返回码定义混乱的亏，有的 API 用返回码是 int 类型，有的是 string 类型，有的用 0 表示成功，又有的用 1 表示成功，还有用”true” 表示成功，碰上这种事情，只能说：头疼API 返回码的设计还是要认真对待，毕竟好的返回码设计可以降低沟通成本以及程序的维护成本。
面试官：如何设计API返回码（错误码）？
芋艿V
10-26 158
???? 这是一个或许对你有用的社群???? 一对一交流/面试小册/简历优化/求职解惑，欢迎加入「芋道快速开发平台」知识星球。下面是星球提供的部分资料：《项目实战（视频）》：从书中学，往事上“练”《互联网高频面试题》：面朝简历学习，春暖花开《架构 x 系统设计》：摧枯拉朽，掌控面试高频场景题《精进 Java 学习指南》：系统学习，互联网主流技术栈《必读 Java 源码专栏》：知其然，知其所以然????这是一个或许...
如何设计API返回码（错误码）？
最新发布
竹林幽深
12-22 112
二、HTTP 状态码参考。
Spring Cloud 架构设计之API接口错误码定义
yjjhk的专栏
05-20 1596
基于Spring Cloud开发一款互联网产品的点点滴滴，本文主要介绍在微服务中API错误码的定义
API接口设计
04-02
财付通 博文链接：https://hudeyong926.iteye.com/blog/910231
API错误码设计-资料
weixin_30698297的博客
03-29 192
搜索到一篇文章：新浪微博API错误代码说明对照表 可以参考新浪微博的错误码设计思路，设计自己系统的错误码。 转载于:https://www.cnblogs.com/Tpf386/p/8670456.html...
服务端错误码规则设计
ludengji的专栏
06-20 4846
错误码暂定都是5位数字，并配有相应的英文解释错误码为 0 表示成功，其他都表示错误错误码按模块按功能场景分级分段，前三位错误码表示模块，第四位表示模块下的功能。举例，商城系统里有交易模块和商品模块，则可以这样划分：401开头的表示交易模块，402开头的表示商品模块，4011开头的表示交易模块里的下单场景需要用到的错误码，4021表示商品模块下的添加商品场景里需要用到的错误码。如果某个场景功能下
错误码设计个格式
thanklife的专栏
10-21 1529
{"code": 1, "msg": "parameter invalid"} 参考微信的全局返回码，以Http+JSON作为应答消息 格式为： {"errCode": code,  "errMsg": "msg",  "data": {} } code 习惯上去0为success， -1 为fail， 其它是 模块号+错误号拼装
常见错误码及定义
热门推荐
02-03 2万+
常见错误码及定义 目录 一、授权／令牌请求接口返回码二、API通用返回码 一、授权／令牌请求接口返回码 描述应用发起授权请求或令牌请求时，开放平台的返回码。 错误码 错误描述 Error Description 10000 非法的请求参数 Invalid reques
用产品思维设计API（四）——随意定义错误码，你还在这样干？
北漂周的专栏（微信：stchou_zst）
01-31 1万+
用产品思维设计API（三）——版本控制，没有你想的这么简单前言 最近公司内部在重构项目代码，包括API方向的重构，期间遇到了很多的问题，不由得让我重新思考了下。 - 一个优雅的API该如何设计？ - 前后端分离之后，API真的解耦分离了吗？ - 不断的版本迭代，API的兼容性该如何做？ ps.这里所说的API仅为Web API，提供APP\WEB开发使用。 年前，我司
跨项目组项目开发之错误码设计
DeveloperX的博客
08-27 2622
跨项目组项目开发，错误码设计 引言 当项目还是大单体的时候，当项目还是一个项目组开发的时候，当项目还是自给自足不需要对外提供服务接口的时候，当项目还不涉及多个业务部门甚至部门是跨国的部门的时候，你也许都不需要考虑错误和故障的快速定位，你的服务接口中甚至不存在错误码。 那么在银行，当这些情况都发生了，你要怎么做？ 以广发行的贷中业务需求为例，在进行已有卡信贷过程的风险控制，数据流就经历了5个...
网络层架构设计与实战十五错误码的处理
nicolelili1的专栏
02-08 525
1、错误码的处理本身和网络框架关联并不大，原因是错误码的处理本身是属于业务逻辑的，每种错误码的处理方式是不一样的。 2、如果错误码等于0，说明结果是正确的，可以正常返回，否则说明需要进行异常处理 package www.imooc.com.okhttp; import android.content.Context; import com.n
api的错误代码设计
weixin_30642305的博客
10-03 228
http://open.weibo.com/wiki/Error_code 转载于:https://www.cnblogs.com/norm/p/7623178.html
Java服务器端 API 错误码设计总结
weixin_30564785的博客
07-16 860
1.对于API结果返回，定义BaseResult 类 拥有success，errorCode，errorMsg个3个基本参数，success使用Boolean类型，errorCode使用Integer类型，errorMsg使用String类型 对于success，false表示接口请求失败，true表示接口请求成功。 对于errorCode，当success=true时为0，其他请参阅ABB...
C ++ 中不容忽视的 25 个 API 错误设计！
runner668的博客
05-26 545
来自网站 极客分享 https://geek-share.com/ 对于许多C ++开发人员来说，API设计可能会在其优先级列表中排名第3或第4。大多数开发人员都倾向于使用C ++来获得原始功能和控制权。因此，性能和优化的想法占据这些开发者的时间的百分之八十。 当然，每个C ++开发人员都会考虑头文件设计的各个方面，但是API设计不仅仅是头文件设计那样。事实上，我强烈建议每一个开发人员在其A...
错误码规范
Star_CSU的博客
10-11 3031
错误码规范的好处 1.看到错误码就大概知道哪儿出了问题 2.方便制定错误码 3.减少服务内错误码重复的情况 规范如下： 错误码长度：六、五位数，示例：1-11-11，共分为三个模块，解释如下： 第一位 第二位 第三位 第四位 第五位 A B ...
服务API设计 之 API错误返回规范
黄老师的博客
09-24 747
API错误返回规范 禁止通过抛异常形式返回API业务错误 API禁止抛Checked异常，即业务处理上的参数错误、逻辑错误、业务错误等禁止通过抛异常形式返回，应用Response#code, message表达业务错误。 注：不要逼调用方到处写try{}catch()。 正例： Response<T> saveDesposit(...); 反例： T saveDesposit(...) throws ServiceException, IllegalArgumentException
中间件API错误码解析与对接指南
首先，API的返回值设计是统一的：成功执行返回0，失败则返回特定的错误码。错误码按模块类别进行区分，例如摄像头类错误码以-1000开始递增，读卡器类以-200开始递增。对于无法明确归类的错误，使用通用错误码表示。 ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值