首页
学习
活动
专区
圈层
工具
发布
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

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

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

    7.7K30

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

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

    1.4K10

    让Laravel API永远返回JSON格式响应的方法示例

    JSON采用与编程语言无关的文本格式,但是也使用了类C语言(包括C, C++, C#, Java, JavaScript, Perl, Python等)的习惯,这些特性使JSON成为理想的数据交换格式。...本文将给大家详细介绍关于让Laravel API永远返回JSON格式响应的方法,下面话不多说了,来一起看看详细的介绍吧 当你在编写完全为 API 服务的 Laravel 应用时,你希望所有响应都是 JSON...格式的,而不是例如说授权错误会重定向到 /home 或 /login,最终重定向会变成 InvalidArgumentException: Route [login] is not defined....的视图。 下面这个简单的方案,可以让你的 Laravel 应用优先响应为 JSON 格式。...现在所/ /有的响应都是 application/json ,包括错误和异常。

    3.9K10

    闲鱼商品详情API返回字段全解析(附JSON示例)

    一、前言闲鱼商品详情API是阿里巴巴旗下二手交易平台闲鱼提供的开发者接口,用于通过商品ID获取商品的详细信息,包括标题、价格、描述、图片等数据。...3.返回数据接口返回JSON格式数据,主要包含以下字段:状态信息:code(状态码)、message(返回消息)。商品数据:title(标题)、price(价格)、description(描述)。...三、Python请求示例以下是使用Python调用闲鱼商品详情API的完整示例代码:# coding:utf-8""" Compatible for python2.x and python3.x requirement...__ == "__main__": r = requests.get(url, headers=headers) json_obj = r.json() print(json_obj)代码功能说明:1....2.请求构造:包含必要的app_key、item_id和timestamp参数。3.错误处理:包含HTTP状态码和API返回状态的检查。4.数据解析:正确处理返回的JSON格式数据。

    41410

    Spring Boot 无侵入式 实现 API 接口统一 JSON 格式返回

    无侵入式 统一返回JSON格式 其实本没有没打算写这篇博客的,但还是要写一下写这篇博客的起因是因为,现在呆着的这家公司居然没有统一的API返回格式?...在仔细的阅读了项目源码后发现,在API请求的是居然没有业务异常(黑人问好)。好吧 居然入坑了只能遵照项目风格了,懒得吐槽了。...JSON格式了, 但是我们也发现了一个问题了,想要返回统一的JSON格式需要返回Result才可以, 我明明返回Object可以了, 为什么要重复劳动, 有没有解决方法, 当然是有的啦,...下面我们开始优化我们的代码吧 统一返回JSON格式进阶-全局处理(@RestControllerAdvice) 我师傅经常告诉我的一句话: “你就是一个小屁孩, 你遇到的问题都已经不知道有多少人遇到过了...是会直接抛出异常的接口,我好像没有对异常返回进行统一的处理哦 统一返回JSON格式进阶-异常处理(@ExceptionHandler)) 卧槽, 异常处理, 差点把这茬给忘了, 这个异常处理就有很多方法了

    1.4K40

    Spring Boot 无侵入式 实现API接口统一JSON格式返回

    JSON格式 其实本没有没打算写这篇博客的,但还是要写一下写这篇博客的起因是因为,现在呆着的这家公司居然没有统一的API返回格式?...在仔细的阅读了项目源码后发现,在API请求的是居然没有业务异常(黑人问好)。好吧 居然入坑了只能遵照项目风格了,懒得吐槽了。...JSON格式了, 但是我们也发现了一个问题了,想要返回统一的JSON格式需要返回Result才可以, 我明明返回Object可以了, 为什么要重复劳动, 有没有解决方法, 当然是有的啦,...下面我们开始优化我们的代码吧 统一返回JSON格式进阶-全局处理(@RestControllerAdvice) 我师傅经常告诉我的一句话: “你就是一个小屁孩, 你遇到的问题都已经不知道有多少人遇到过了...是会直接抛出异常的接口,我好像没有对异常返回进行统一的处理哦 统一返回JSON格式进阶-异常处理(@ExceptionHandler)) 卧槽, 异常处理, 差点把这茬给忘了, 这个异常处理就有很多方法了

    1.6K40

    微信 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

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

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

    10.3K30

    python解析url返回的json格式

    1.python代码 # --*-- coding=utf-8 --*-- import urllib2 import urllib import json weatherHtml = urllib.urlopen...keyword=周杰伦&pagesize=1') #通过urllib模块中的urlopen的方法打开url weatherHtml1 = weatherHtml.read() #通过read方法获取返回数据...print "url返回的json数据:",weatherHtml1 #打印返回信息 weatherJSON = json.loads(weatherHtml1) #将返回的json格式的数据转化为python...对象,json数据转化成了python中的字典,按照字典方法读取数据 print "python的字典数据:",weatherJSON print "字典中的data数据",weatherJSON["data...["data"]["lists"][0]["SongName"] #lists的0号数据是一个字典,按照字典方法查看数据 url返回的json数据 本文出自http://www.cnblogs.com

    4.1K10

    API 错误码不统一?六类错误响应的落地模板(JSON示例+表格)

    一句话承诺:提供可抄的错误响应模板与分类表,快速统一前后端的错误处理。...分类表 分类 典型HTTP 建议码段 示例 验证错误 400 1000-1999 字段缺失、格式错误 未认证 401 2000-2099 Token无效或过期 无权限 403 2100-2199 角色不匹配...资源未找到 404 3000-3099 ID不存在 业务冲突 409 4000-4099 状态不允许 服务器错误 500 5000-5999 异常未捕获 JSON 模板(可统一落地) { "code...对验证错误提供 details 数组,便于前端逐项提示。 常见坑与替代法 坑:把所有错误都返回 200。替代:语义化HTTP码,有助于中间件与缓存策略。 坑:错误码无规则。...替代:贯穿全链路的请求ID,便于定位问题。 下一篇预告 JWT“过期刷新”太混乱?最简单的刷新策略与黑名单设计(时序图)。

    14810

    springmvc学习笔记--json--返回json的日期格式问题

    转换器,我们添加了上面的依赖包后就可以使用注解@ResponseBody来返回json数据,比如: 1 @RequestMapping("json") 2 @ResponseBody 3...输出的日期格式 上面虽然输出了json,但json的date类型的属性都是long值,像在页面取出是国外的日期格式一样,我们需要加一个格式转换,将日期的格式转换成想要的格式:yyyy-MM-dd。...2.继承ObjectMapper来实现返回json字符串 参考:http://aokunsang.iteye.com/blog/1878985 在上面的方法中虽然简单方便,但缺点也很明显,自动生成代码会覆盖实体类...统一成yyyy-MM-dd HH:mm:ss MappingJacksonHttpMessageConverter主要通过ObjectMapper来实现返回json字符串。...3.使用内置的日期格式化工具 同样是全局设置json响应的日期格式,但此方法可以和@JsonFormat共存,也就是说可以全局设置一个格式,特定的需求可以使用注解设置。

    3.4K100
    领券