余晖落尽暮晚霞,黄昏迟暮远山寻
本站
当前位置:网站首页 > 编程知识 > 正文

趣说API HTTP 状态码的使用(http api什么意思)

xiyangw 2022-11-24 16:57 48 浏览 0 评论

在设计API HTTP 状态码的时候,我们总能听到两种声音:

第一种,也是大家最常用的:

趣说API HTTP 状态码的使用(http api什么意思)

所有接口的状态码都返回 `200`,然后在自定义错误码:

# 正确响应
{
  "code: 200,
  "message": "success",
  "data": {
    "id": ...,
    ...
  }
}
# 错误响应
{
  "code: 1001, // 自定义错误类型
  "message": "error message",
  "data": {}
}

另一种,Rest API,仅使用HTTP状态代码:

# 正确响应

HTTP/1.1 200

Content-Type: application/json

{

    "id": ...,

    ...

}

# 错误响应

HTTP/1.1 401 Unauthorized

{

  "message": "Bad credentials"

}

更多的错误码规范可以直接从 [HTTP Status Code ](https://httpstatuses.com/)查看。

为什么说是两种声音,其实现在基本规范的话都会直接选择第二种,基本上,Github的

[Github API v3](https://developer.github.com/v3/)以及现在普遍后端框架的设计都对于`Rest API` 有着更好的支持。

所以上面声音的争执似乎存在与前后端的更多些。

> 补充一下 `Github v4` 版本已经开始使用[ `GraphQL`](https://developer.github.com/v4/)了,`GraphQL` 是一种查询语言,相比于`Rest API`的设计,现在国外比较喜欢和流行`GraphQL` ,但好像国内还并未听说有过多的使用。

说一下两者的优缺点吧,

第一种:

  • 优点:客户端仅需要处理作为 json字符串的响应主体并忽略状态。
  • 缺点:标准化低。


第二种:

  • 优点:标准化高,客户端仅需要处理作为json字符串的响应主体并忽略状态。
  • 缺点:业务复杂度高时的使用场景使用不足。


而结合两种优缺点,现在许多人开始有了第三种方式:

`HTTP Status 与Json body 相结合`

  • 优点:依旧能保证标准化,可以处理兼容更多的业务场景。
  • 缺点:客户端处理的复杂度高,需要根据业务场景做更多的判断选择

#### 参考资料

[Github API v3](https://developer.github.com/v3/)

[HTTP Status Code ](https://httpstatuses.com/)

[dingo-api 错误响应](https://github.com/dingo/api/wiki/Errors-And-Error-Responses)

[ Github v4](https://developer.github.com/v4/)

相关推荐

辞旧迎新,新手使用Containerd时的几点须知

相信大家在2020年岁末都被Kubernetes即将抛弃Docker的消息刷屏了。事实上作为接替Docker运行时的Containerd在早在Kubernetes1.7时就能直接与Kubelet集成使...

分布式日志系统ELK+skywalking分布式链路完整搭建流程

开头在分布式系统中,日志跟踪是一件很令程序员头疼的问题,在遇到生产问题时,如果是多节点需要打开多节点服务器去跟踪问题,如果下游也是多节点且调用多个服务,那就更麻烦,再者,如果没有分布式链路,在生产日志...

Linux用户和用户组管理

1、用户账户概述-AAA介绍AAA指的是Authentication、Authorization、Accounting,即认证、授权和审计。?认证:验证用户是否可以获得权限,是3A的第一步,即验证身份...

linux查看最后N条日志

其实很简单,只需要用到tail这个命令tail-100catalina.out输入以上命令,就能列出catalina.out的最后100行。...

解决linux系统日志时间错误的问题

今天发现一台虚拟机下的系统日志:/var/log/messages,文件时间戳不对,跟正常时间差了12个小时。按网上说的执行了servicersyslogrestart重启syslog服务,还是不...

全程软件测试(六十二):软件测试工作如何运用Linux—读书笔记

从事过软件测试的小伙们就会明白会使用Linux是多么重要的一件事,工作时需要用到,面试时会被问到,简历中需要写到。对于软件测试人员来说,不需要你多么熟练使用Linux所有命令,也不需要你对Linux...

Linux运维之为Nginx添加错误日志(error_log)配置

Nginx错误日志信息介绍配置记录Nginx的错误信息是调试Nginx服务的重要手段,属于核心功能模块(nginx_core_module)的参数,该参数名字为error_log,可以放在不同的虚机主...

Linux使用swatchdog实时监控日志文件的变化

1.前言本教程主要讲解在Linux系统中如何使用swatchdog实时监控日志文件的变化。swatchdog(SimpleWATCHDOG)是一个简单的Perl脚本,用于监视类Unix系统(比如...

syslog服务详解

背景:需求来自于一个客户想将服务器的日志转发到自己的日志服务器上,所以希望我们能提供这个转发的功能,同时还要满足syslog协议。1什么是syslog服务1.1syslog标准协议如下图这里的fa...

linux日志文件的管理、备份及日志服务器的搭建

日志文件存放目录:/var/log[root@xinglog]#cd/var/log[root@xinglog]#lsmessages:系统日志secure:登录日志———————————...

运维之日志管理简介

日志简介在运维过程中,日志是必不可少的东西,通过日志可以快速发现问题所在。日志分类日志分类,对不同的日志进行不同维度的分析。操作系统日志操作系统是基础,应用都是在其之上;操作系统日志的分析,可以反馈出...

Apache Log4j 爆核弹级漏洞,Spring Boot 默认日志框架就能完美躲过

这两天沸沸扬扬的Log4j2漏洞门事件炒得热火朝天:突发!ApacheLog4j2报核弹级漏洞。。赶紧修复!!|Java技术栈|Java|SpringBoot|Spring...

Linux服务器存在大量log日志,如何快速定位错误?

来源:blog.csdn.net/nan1996jiang/articlep/details/109550303针对大量log日志快速定位错误地方tail/head简单命令使用:附加针对大量log日志...

Linux中查看日志文件的正确姿势,求你别tail走天下了!

作为一个后端开发工程师,在Linux中查看查看文件内容是基本操作了。尤其是通常要分析日志文件排查问题,那么我们应该如何正确打开日志文件呢?对于我这种小菜鸡来说,第一反应就是cat,tail,vi(或...

分享几款常用的付费日志系统,献给迷茫的你!

概述在前一篇文章中,我们分享了几款免费的日志服务器。他们各有各的特点,但是大家有不同的需求,有时免费的服务器不能满足大家的需要,下面推荐几款付费的日志服务器。1.Nagios日志服务器Nagio...

取消回复欢迎 发表评论: