记录WCF API错误(最佳方式)

本文关键字:最佳 方式 错误 WCF API 记录 | 更新日期: 2023-09-27 18:12:36

我知道,现在太晚了,我们应该提前创建所有可能的错误列表。我们以前不能这样做,因为我们使用另一个API来服务我们的API,并且第三方API为我们提供了任何错误的德语消息。

现在我们的一个客户要求提供可能的错误消息列表,以便他们相应地处理。

你能给我一个理想的方法来记录错误列表吗?我本打算从excel电子表格开始,但我觉得应该有更好的方法。

记录WCF API错误(最佳方式)

在WCF中,您应该使用FaultException。实际上,您可以从FaultException派生,这些将通过网络序列化。

这样,你的服务将正确地传递异常(例如:序列化为SOAP),您的消费者可以处理。

这就是为什么它在那里。但是考虑到您是在生产环境中,您可能没有选择。

您可以使用标准的c# XML文档语法,解释每个方法可以抛出什么。参见:http://msdn.microsoft.com/en-us/library/b2s063f7 (v = VS.100) . aspx

然后你可以使用Sandcastle之类的工具来呈现文档,它会生成msdn风格的文档。

像GhostDoc这样的工具可以帮助你更快地写这些。

由于您已经在生产中,我将为代码编写一个补丁并将其搁置在源代码控制中。