首页 > 其他分享 >后端API接口定义返回编码规则

后端API接口定义返回编码规则

时间:2024-07-22 16:52:25浏览次数:13  
标签:返回 编码 code HTTP 错误 状态 API 接口定义 区间

code状态码

code返回状态码,一般小伙伴们是在开发的时候需要什么,就添加什么。

如接口要返回用户权限异常,我们加一个状态码为101吧,下一次又要加一个数据参数异常,就加一个102的状态码。这样虽然能够照常满足业务,但状态码太凌乱了。

我们应该可以参考HTTP请求返回的状态码(下面是常见的HTTP状态码):

200 - 请求成功
301 - 资源(网页等)被永久转移到其它URL
404 - 请求的资源(网页等)不存在
500 - 内部服务器错误

image
我们可以参考这样的设计,这样的好处就把错误类型归类到某个区间内,如果区间不够,可以设计成4位数。

#1000~1999 区间表示参数错误
#2000~2999 区间表示用户错误
#3000~3999 区间表示接口异常

再在枚举中定义,状态码
image
我们要设计一个返回体类Result
image

标签:返回,编码,code,HTTP,错误,状态,API,接口定义,区间
From: https://www.cnblogs.com/cgy1995/p/18316381

相关文章

  • 深信服务超融合管理Api调用
    usingJint;usingSystem;usingSystem.Collections.Generic;usingSystem.ComponentModel;usingSystem.Data;usingSystem.Drawing;usingSystem.Linq;usingSystem.Text;usingSystem.Threading.Tasks;usingSystem.Windows.Forms;usingSystem.IO;usingSystem......
  • Go语言中使用K8s API及一些常用API整理
    Go语言中使用K8sAPI及一些常用API整理发布于 2022-05-0915:54:402K0举报文章被收录于专栏:devops_k8sGoClient在进入代码之前,理解k8s的goclient项目是对我们又帮助的。它是k8sclient中最古老的一个,因此具有很多特性。Client-go没有使用Swagger......
  • 如何修复包含 OpenAi api 的 Flask 服务器的 405 错误?
    我正在尝试向我的网页添加API,之前从未使用过任何Flask服务器,也从未使用过Javascript,所以这是一次全新的学习体验。我的问题是我不断收到405错误代码,指出该方法不被允许。我继续使用POST方法,但它不起作用,我相信我的问题可能更多地出在我的HTML代码而不是我的Flask服......
  • 在 VSCode 中通过 Python 使用 YouTube API 时如何启用 Intellisense
    我想在使用GoogleYouTubeAPI和Python时在VSCode中获得IntelliSense。但我不知道详细步骤。fromgoogleapiclient.discoveryimportbuildapi_key="****"youtube=build("youtube","v3",developerKey=api_key)request=youtube.channels().list(part......
  • 纳米体育数据API电竞数据接口:指数数据包接口文档API示例①
    纳米体育数据的数据接口通过JSON拉流方式获取200多个国家的体育赛事实时数据或历史数据的编程接口,无请求次数限制,可按需购买,接口稳定高效;覆盖项目包括足球、篮球、网球、电子竞技、奥运等专题、数据内容。纳米数据API2.0版本包含http协议以及websocket协议,主要通过http获取数......
  • 首发:vue开发微信小程序文本内容安全审核php api接口代码完整分享
    微信小程序的文本内容安全审核,有用户输入内容的小程序都用的上,本人自己项目开发使用的接入代码分享给大家,直接复制粘贴过去就能用,如果用的上记得点赞支持。上代码,配合之前发的access_token获取接口使用,把下面代码里面的token刷新接口地址换成你的即可。https://blog.csdn.net/......
  • LTC莱特币实时行情API接口
    LTC莱特币实时行情API接口#RestfulAPIhttps://tsanghi.com/api/fin/crypto/realtime?token={token}&ticker={ticker}指定加密货币代码,获取该加密货币的实时行情(开、高、低、收)。更新周期:实时。请求方式:GET。#莱特币测试接口https://tsanghi.com/api/fin/cr......
  • c# swagger api分组
    ConfigureServices修改services.AddSwaggerGen(c=>{c.SwaggerDoc("v1",newOpenApiInfo{Title="SwaggerTest",Version="v1"});c.SwaggerDoc("User",newOpenApiInfo{Title="U......
  • 1、Flink 的 Table API & SQL API 概述
    1)概览1.TableAPI&SQLFlink有两种关系型API来做流批统一处理:TableAPI和SQL。TableAPI是用于Scala和Java语言的查询API,它可以用一种非常直观的方式来组合使用选取、过滤、join等关系型算子。FlinkSQL是基于ApacheCalcite来实现的标准SQL。无论输入......
  • Java流的概念及API
    流的概念 流(Stream)的概念代表的是程序中数据的流通,数据流是一串连续不断的数据的集合。在Java程序中,对于数据的输入/输出操作是以流(Stream)的方式进行的。可以把流分为输入流和输出流两种。程序从输入流读取数据,向输出流写入数据。Java中的流可以按如下方式分类:按流的方......