Java服务器端 API 错误码设计总结

1.对于API结果返回,定义BaseResult 类拥有success,errorCode,errorMsg个3个基本参数,success使用Boolean类型,errorCode使用Integer类型,errorMsg使用String类型对于success,false表示接口请求失败,true表示接口请求成功. 对于errorCode,当success=true时为0,其他请参阅ABBCCC格式错误码. 对于errorMsg,当success=true时为null,其他情况不为null.…

API错误码设计-资料

搜索到一篇文章:新浪微博API错误代码说明对照表可以参考新浪微博的错误码设计思路,设计自己系统的错误码.…

火币网API文档——REST API 错误码

错误码行情 API 错误码错误码描述 bad-request 错误请求 invalid-parameter 参数错 invalid-command 指令错 code 的具体解释, 参考对应的err-msg 交易 API 错误码错误码描述 base-symbol-error 交易对不存在 base-currency-error 币种不存在 base-date-error 错误的日期格式 account-transfer-balance-insufficient-error 余额不足无…

Go 实现自动检索 API 错误码代码行并打印成文档，例 markDown 形式等

作者:林冠宏 / 指尖下的幽灵掘金:https://juejin.im/user/587f0dfe128fe100570ce2d8 博客:http://www.cnblogs.com/linguanh/ GitHub : https://github.com/af913337456/ 腾讯云专栏: https://cloud.tencent.com/developer/user/1148436/activities 源码--GitHub:https://github.com/af9133374…

Windows API 错误码

在多数情况下,windows API在发生错误时很少抛出异常,多数是通过函数返回值进行处理.(windows api中无返回值的函数很少.) windows api错误处理通常按照以下方式:首先api函数返回特殊的值,表明函数内部发生错误:然后调用方可以使用GetLastError获得对应的错误码. 通常情况下windows api按照返回类型可以分为以下几类: 返回值为BOOL类型.有错误发生,返回值为0,否则返回非零值. 返回值为HANDLE类型.有错误发生时,返回NULL或INVALID_…

AgileBoot - 项目内统一的错误码设计

本篇文章主要探讨关于统一错误码的设计,并提供笔者的实现欢迎大家讨论,指正. 该错误码的设计在仓库: github:https://github.com/valarchie/AgileBoot-Back-End gitee:https://gitee.com/valarchie/AgileBoot-Back-End 统一的错误码管理的优点统一的错误码描述,如果没有统一的错误码的话,错误描述散落在项目内的不同地方,同一个错误码却产生不同的错误描述,会导致歧义. 错误码的层级,在与客户端的交互过程…

[2017-08-28]Abp系列——业务异常与错误码设计及提示语的本地化

本系列目录:Abp介绍和经验分享-目录前言 ABP中有个异常UserFriendlyException经常被使用,但是它所在的命名空间是Abp.UI,总觉得和展现层联系过于紧密,在AppService中用也就罢了,在领域层中用它总觉得有点不合适. 那么怎么定义业务异常?既要用起来舒服又能体现业务意义? 几点目标无需每个业务领域都定义各自的异常类,但使用时要有一定的可读性,能区分不同业务: 要有错误码: 每个错误码对应的提示语不能硬编码,最好能使用已有的本地化语言机制: 要有日志级别,不同的业…

JPush极光推送Java服务器端API

// 对android和ios设备发送 JPushClient jpush = new JPushClient(masterSecret, appKey); // 对android和ios设备发送,同时指定离线消息保存时间 JPushClient jpush = new JPushClient(masterSecret, appKey, timeToLive); // 指定某种设备发送 JPushClient jpush = new JPushClient(masterSecret, a…

火币网API文档——WebSocket API错误码

错误信息返回格式 { "id": "id generate by client", "status": "error", "err-code": "err-code", "err-msg": "err-message", "ts": 1487152091345 } 注:"ts" 为错误信息生成的时间戳,单位:…

Windows错误码解析

C或者C++开发肯定经常会遇到各种错误码,由于每个错误码只是一个枚举或者一个整形数值,调试或者输出日志的时候,无法知道这个错误码的具体含义,这时候就需要将此错误码解释出来.对于自己定义的错误码,可以通过自己的方式进行解析.对于Windows API的错误码,则需要调用Windows的API进行解析,下面来介绍具体的错误码解析方法. Windows API 错误码解析调用Windows API失败后,通常需要通过GetLastError来获取对应的错误码,要将此错误码解析为对应的描述信息,则需要…

Java异常封装（自己定义错误码和描述，附源码）

真正工作了才发现,Java里面的异常在真正工作中使用还是十分普遍的.什么时候该抛出什么异常,这个是必须知道的. 当然真正工作里面主动抛出的异常都是经过分装过的,自己可以定义错误码和异常描述. 下面小宝鸽就为大家介绍一个Java异常简单封装的例子. 在给出异常分装例子之前,需要给大家普及Java里面的checked异常和unchecked异常的个概念. 一.checked异常和unchecked异常这里之所以让大家清楚checked异常和unchecked异常概念,是因为:待会我们的异常是继承u…

安装APK的错误码（PackageManager.java）

安装APK的错误码,定义在android源码中的这个文件中:frameworks\base\core\java\android\content\pm\PackageManager.java /** * if the package is already installed. * 程序已经存在 */ public static final int INSTALL_FAILED_ALREADY_EXISTS = -1; /** * if the package archive file is inv…

Java异常封装（自定义错误码和描写叙述，附源代码）

真正工作了才发现.Java里面的异常在真正工作中使用还是十分普遍的. 什么时候该抛出什么异常,这个是必须知道的. 当然真正工作里面主动抛出的异常都是经过分装过的,自己能够定义错误码和异常描写叙述. 以下小宝鸽就为大家介绍一个Java异常简单封装的样例. 在给出异常分装样例之前.须要给大家普及Java里面的checked异常和unchecked异常的个概念. 一.checked异常和unchecked异常这里之所以让大家清楚checked异常和unchecked异常概念,是由于:待会我们的异常是…

防盗链&CSRF&API接口幂等性设计

防盗链技术 CSRF(模拟请求) 分析防止伪造Token请求攻击互联网API接口幂等性设计忘记密码漏洞分析 1.Http请求防盗链什么是防盗链比如A网站有一张图片,被B网站直接通过img标签属性引入,直接盗用A网站图片展示. 如果别人的项目频繁引用我的图片的话别人请求放访问的是我的服务器也会浪费我的宽带如何实现防盗链判断http请求头Referer域中的记录来源的值,如果和当前访问的域名不一致的情况下,说明该图片可能被其他服务器盗用. Referer字段中记录了访问的来源(浏…

App开放接口api安全性的设计与实现

前言在app开放接口api的设计中,避免不了的就是安全性问题,因为大多数接口涉及到用户的个人信息以及一些敏感的数据,所以对这些接口需要进行身份的认证, 那么这就需要用户提供一些信息,比如用户名密码等,但是为了安全起见让用户暴露的明文密码次数越少越好,我们一般在web项目中,大多数采用保存的session中, 然后在存一份到cookie中,来保持用户的回话有效性.但是在app提供的开放接口中,后端服务器在用户登录后如何去验证和维护用户的登陆有效性呢? 设计对于敏感的api接口,需使用https…

CMPP错误码说明

与中国移动代码的对应关系. MI::zzzzSMSC返回状态报告的状态值为EXPIREDMJ:zzzzSMSC返回状态报告的状态值为DELETEDMK:zzzzSMSC返回状态报告的状态值为UNDELIVML:zzzzSMSC返回状态报告的状态值为ACCEPTDMM:zzzzSMSC返回状态报告的状态值为UNKNOWNMN:zzzzSMSC返回状态报告的状态值为REJECTD 回页首 CMPP发送失败代码对照表值(4位,不足4位前面补0) 含义1 消息结构错2 命令字错误3 消息序列号重复4…

Spring Boot HTTP over JSON 的错误码异常处理

摘要: 原创出处:www.bysocket.com 泥瓦匠BYSocket 希望转载,保留摘要,谢谢! “年轻人不要怕表现,要敢于出来表现,但还是那句话,要有正确的度,你的表现是分析问题和解决问题的能力.” – <你凭什么做好互联网> 本文提纲一.异常统一处理的使用场景二.运行 springboot-validation-over-json 工程三.springboot-validation-over-json 工程代码详解一.异常统一处理的使用场景在前后端分离开发中,经常用 HTTP o…

开放接口/RESTful/Api服务的设计和安全方案详解

一.总体思路这个涉及到两个方面问题:一个是接口访问认证问题,主要解决谁可以使用接口(用户登录验证.来路验证)一个是数据数据传输安全,主要解决接口数据被监听(HTTPS安全传输.敏感内容加密.数字签名) 二.session的状态保持及弊端当用户第一次通过浏览器使用用户名和密码访问服务器时,服务器会验证用户数据,验证成功后在服务器端写入session数据,向客户端浏览器返回sessionid,浏览器将sessionid保存在cookie中,当用户再次访问服务器时,会携带sessionid,服务器会…

转！！CMPP 网关错误码说明

http://www.163duanxin.com/msg/1753.htm CMPP错误码说明与中国移动代码的对应关系. MI::zzzzSMSC返回状态报告的状态值为EXPIREDMJ:zzzzSMSC返回状态报告的状态值为DELETEDMK:zzzzSMSC返回状态报告的状态值为UNDELIVML:zzzzSMSC返回状态报告的状态值为ACCEPTDMM:zzzzSMSC返回状态报告的状态值为UNKNOWNMN:zzzzSMSC返回状态报告的状态值为REJECTD 回页首 CMPP发…

Web API系列(一)设计经验与总结

在移动互联网的时代, Web服务已经成为了异构系统之间的互联与集成的主要手段,各种 Web服务几乎都采用REST风格的Web Api来构建. 通过Http协议的形式来. 以Get/Post方式发送请求, 返回json格式(数据更小巧且自描述能力强)的数据.这里就不在介绍REST API 的好处和不足.这些网上一大堆资料.今天就说说,如何构建优秀的REST API ? 目前,各大互联网公司, 对自身的REST Api设计有各自的标准,他们的Api 的设计也非常成熟. 那么,我们应该如何更好的设计我…

关于 Java Collections API 您不知道的 5 件事，第 1 部分

定制和扩展 Java Collections Java™ Collections API 远不止是数组的替代品,虽然一开始这样用也不错.Ted Neward 提供了关于用 Collections 做更多事情的 5 个技巧,包括关于定制和扩展 Java Collections API 的基础. 对于很多 Java 开发人员来说,Java Collections API 是标准 Java 数组及其所有缺点的一个非常需要的替代品.将 Collections 主要与 ArrayList 联系到一起本身没…

关于 Java Collections API 您不知道的 5 件事--转

第 1 部分 http://www.ibm.com/developerworks/cn/java/j-5things2.html 对于很多 Java 开发人员来说,Java Collections API 是标准 Java 数组及其所有缺点的一个非常需要的替代品.将 Collections 主要与 ArrayList联系到一起本身没有错,但是对于那些有探索精神的人来说,这只是 Collections 的冰山一角. 关于本系列您觉得自己懂 Java 编程?事实上,大多数程序员对于 Java 平台…

【转载】Java Restful API 文档生成工具 smart-doc

谁说生成api文档就必须要定义注解? 谁说生成接口请求和返回示例必须要在线? 用代码去探路,不断尝试更多文档交付的可能性. 如果代码有生命,为什么不换种方式和它对话! 一.背景没有背景.就自己做自己的背景在当今各种盛行的前后端分离.restful service开发过程中,接口文档是必不可少的.对于前后端分离的开发中,后端开发需要将接口写好后需要告诉前端工程师接口的请求参数.响应示例等重要信息,而对于对外暴露的restful接口服务,我们提供接口也是需要具备相同的接口文档的. 但是对于后端工…

cURL函数库错误码说明之PHP curl_errno函数

背景概述:游戏接口是使用PHP cURL扩展进行请求操作.但是,被请求的服务器经常会无故的不响应或者超时.总之,就是请求之后收不到响应回来的数据.这时候可不能说对方API接口有问题,或者,服务器有故障.总之,可能出现的问题是非常之多.不能一概而论. 一.给出一段常用的PHP cURL代码: function sendRequestGame($url) { $header = array('Expect:'); $ch = curl_init(); curl_setopt($ch, CURLOPT…

UTF-8,Unicode,GBK,希腊字母读法,ASCII码表,HTTP错误码,URL编码表,HTML特殊字符,汉字编码简明对照表

UNICODE,GBK,UTF-8区别 UNICODE,GBK,UTF-8区别简单来说,unicode,gbk和大五码就是编码的值,而utf-8,uft-16之类就是这个值的表现形式．而前面那三种编码是一兼容的,同一个汉字,那三个码值是完全不一样的．如＂汉＂的uncode值与gbk就是不一样的,假设uncode为a040,gbk为b030,而uft-8码,就是把那个值表现的形式．utf-8码完全只针对uncode来组织的,如果GBK要转UTF-8必须先转uncode码,再转utf-8就O…

.NET中异常与错误码优劣势对比

.NET之所以选择异常,而不是返回错误码来报告异常,是由于前者有以下几个优势: 1.异常与oop语言的结合性更好.oop语言经常需要对成员签名强加限制,比如c#中的构造函数.操作符重载和属性,开发者对成员签名中的返回值没有选择余地,故想在oop中统一使用错误码来报告错误是不现实的,替代方案就是在这些特殊场景下使用错误码之外的错误报告机制,比如异常.这样一来,问题就转变为了是否应该在所有地方都使用异常,还是只在特殊场景下使用异常,而在其他情况下仍使用错误码,很明显,从对开发人员友好性方面考虑,始终…