首页
学习
活动
专区
圈层
工具
发布

如何设计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.7K30
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

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

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

    1.4K10

    为了避免出现404页面,你可以添加以下配置来处理后端返回的404错误

    为了避免出现404页面,你可以添加以下配置来处理后端返回的404错误百度网站百度秒收录方法大全?...页面,你可以添加以下配置来处理后端返回的404错误,例如重定向到首页或自定义错误页面。... on;          # 方案1:将404重定向到首页    error_page 404 = @redirect_home;        # 方案2:使用自定义错误页(取消注释即可)    #...# }配置说明:核心机制proxy_intercept_errors on; 使Nginx拦截后端返回的错误状态码(如404),并用error_page处理。...注意:若后端服务本身能正确处理404(返回友好页面),则无需此配置。此方案针对后端直接返回404且需Nginx干预的场景。

    88910

    iis站点设置错误页面返回http状态码为404而不是302或其他

    今天一位客户说网站错误页面返回的状态码是302而不是404,问ytkah要如何处理。这个应该是设置没有正确的原因。我们一步步来排查一下。...1、首先打开iis管理器,左侧选择具体的站点,在右侧窗口中点击404错误页,如下图所示 ?   2、进入详细的错误页配置,选中404状态代码,右侧点编辑 ?   ...3、在弹出的编辑自定义错误页中,相应操作选将静态文件中的内容插入错误相应中,文件路径填404.html(事先把编辑好的404.html放在网站根目录),点确定 ?   ...4、再点击右侧的 编辑功能设置,选自定义错误页,确定 ?   ...5、重启iis   6、用第三方工具检测错误页的http状态码,如果显示的404状态码那就是正确的,如果显示其他那就要按上面的步骤重新配置一下 ?

    4.3K20

    AI 开发者工具评测:Exa 值得用吗?

    第二次在使用自带的WebSearch工具搜索文档之后修复了错误,成功运行并返回结果。使用exa-code的Prompt:你是一个Python专家,并有权访问exa-code工具来检索最新库文档。...aioquicH3Connectionsend_headersstream_idexamplepython`, `tokensNum`:10000}结论:exa-code与Claude原生的WebSearch打成平手,在第一次生成中都调用了错误的方法...API服务Exa公司的产品核心在于提供AI-frendly的网页内容抓取及生成,其衍生的API服务都与此密切关联。...网站结果内容完整性[中文论坛]https://linux.do/t/topic/1035402失败-[个人博客]https://efan404.com/posts/remark42-build-on-the-coolify...对于明确答案的事实性问题会返回一个确定的回答,而对于开放性问题会返回带引用来源的详细总结。这里以查询2025年诺贝尔物理学的获奖者为例,检验其问答效果。

    35610

    使用Spring Boot开发Web项目

    } public void setAge(Integer age) { this.age = age; } } 后台数据构造 在入口类中添加如下代码,由后台向前台页面返回两条数据...); model.addAttribute("people", people); return "index"; } 这里的代码都很简单,不必我多说了,就是返回给前台页面两个对象...container.setPort(8080); container.addErrorPages(new ErrorPage(HttpStatus.NOT_FOUND,"/404...container.setSessionTimeout(10, TimeUnit.MINUTES); } } 自定义类实现 EmbeddedServletContainerCustomizer接口,然后设置端口、设置错误请求页面...、设置会话超时时间等,大家注意这里的404页面放在src/main/resources/static文件夹下,有了这个之后,当我访问一个不存在的页面的时候就会跳转到404.html页面了。

    1.2K50

    网络爬虫框架Scrapy详解之Request

    地址:zhihu.com/people/zarten 介绍 Request类是一个http请求的类,对于爬虫而言是一个很重要的类。...,错误包括404,超时,DNS错误等,第一个参数为Twisted Failure实例 from scrapy.spidermiddlewares.httperror import HttpError from...handlehttpstatuslist http返回码200-300之间都是成功的返回,超出这个范围的都是失败返回,scrapy默认是过滤了这些返回,不会接收这些错误的返回进行处理。...不过可以自定义处理哪些错误返回: yield scrapy.Request(url= 'https://httpbin.org/get/zarten', meta= {'handle_httpstatus_list...' : [404]}) 在parse函数中可以看到处理404错误: def parse(self, response): print('返回信息为:',response.text) handlehttpstatusall

    1.1K00

    ​JDK1.8 新特性 (八):还在重复写空指针检查代码?​

    1、前言 作为一名Java程序员,无论是初入茅庐的菜鸟,还是久经江湖的高手,曾经肯定遭遇过各种各样的异常错误。在国外的一篇文章中,就统计了关于异常类型的排行榜,如下图: ?...Null Reference的发明者Charles Antony Richard Hoare说过: “我称之为我的十亿美元错误。...这是1965年发明空引用的结果……这导致了无数的错误,漏洞和系统崩溃,在最近40年中可能造成十亿美元的痛苦和破坏。”...如果people不为null,根据Optional.isPresent()方法返回true,并通过Optional.get()方法获取值。...后来接触到Optional其他API,我才发现真正体现它价值的是下面这些API。 3.1 Optional.map 从对象中获取某个属性,是最常见的操作。

    1.8K20
    领券