首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >Web服务API错误代码?

Web服务API错误代码?
EN

Stack Overflow用户
提问于 2010-11-12 15:13:15
回答 3查看 374关注 0票数 1

在设计web服务API时,如何组织错误代码?

我的意思是,您如何跟踪您的API错误代码,以便避免同一错误的两个错误代码,等等(似乎有太多的错误代码无法跟踪?)

EN

回答 3

Stack Overflow用户

回答已采纳

发布于 2010-11-12 15:23:22

错误代码出现在您的开发工件中的哪些地方。我通常不在WSDL中使用枚举(也许我应该使用),但我的(Java)代码中确实有枚举或静态常量。因此,如果您将所有这些放在一起,那么在添加新项之前扫描现有列表是相当容易的。然而,我不确定避免重复实际上是一件好事。

最后,只要你能可靠地解释错误代码,即使你有重复的代码,实际上也没什么关系。所以

代码语言:javascript
运行
复制
 10034  - disk full
 23487  - disk full

似乎不会造成太大的伤害,而如果您在代码中的不同点上

代码语言:javascript
运行
复制
 10034 - disk full
 10034 - invalid input

那我们就有问题了。因此,我倾向于将错误代码的范围分配给不同的子系统,并让子系统设计自己的代码。这意味着使用给定错误代码的地方往往很少,因此对错误代码的快速文本搜索(或grep)会将我带到报告问题的代码中的位置。

票数 0
EN

Stack Overflow用户

发布于 2010-11-12 16:10:30

我有两个错误代码,因为有两个错误代码(API和服务代码)是有好处的:

  • 安全-在生产过程中,您不应该通过服务向用户/消费者推送接口/后端详细信息。有两个错误代码意味着试图通过服务攻击您的后端的人无法使用该区域的information.
  • Idenfication -通过两个代码,您可以看到错误来自何处(服务与API)。
  • 您可以更改后端,这可能会引入新代码(或具有与旧代码冲突的新代码),web服务保持稳定,错误代码继续为您的消费者工作。
票数 1
EN

Stack Overflow用户

发布于 2010-11-12 17:27:49

强制您的开发人员显式地从中心位置获取一个数字(可以是数据库序列)。

你甚至可以通过在你的Intranet上提供一个页面来进一步利用这一点,开发人员应该在获得错误号之前首先填写错误的描述。将错误描述与错误号一起放入数据库中。您可以允许其他人进一步扩展此功能,并在此数据库之上构建您的错误文档。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/4162391

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档