什么是与C#开发人员沟通其API中的错误的最佳方式?

时间:2014-06-01 12:35:11

标签: c# api

我正在测试由C#开发人员编写的API。我是Perl开发人员。因此,我希望以语言无关的方式向他们发送错误报告。对于GET请求,这是微不足道的(除非涉及头文件)。但对于POST它不是。

现在,许多记录API的网站都在其文档中使用curl命令,以提供与语言无关的示例。例如Stripe

在Unix或OSX世界中,我会向他们发送一个curl命令,并说当你运行它时,响应会以某种方式被破坏。但curl不是Windows的原生(虽然它可以在Windows上安装和运行)。 C#开发人员是否意识到卷曲?他们使用卷曲吗?我认为他们不会被推到命令行上,但我想不出更好的方式来谈论这些事情。有什么建议吗?

2 个答案:

答案 0 :(得分:3)

  

但是对于POST来说不是。

为什么呢?最后,GET和POST是HTTP。发送已发送的标头,而不是您的API调用。

  

C#devs是否意识到卷曲?

我不是。我不接受这样的错误报告。但我很乐意接受HTTP有效负载作为转储。

  

我认为他们不会因为被推到命令行而感到兴奋,

我不会假设在命令行上推送curl。我会假设它被推到了一个我不喜欢的工具上。我一直使用命令行 - 哎呀,我维护的软件主要是由一些人在命令行中使用。

Windows中的命令行是PowerShell。

答案 1 :(得分:2)

不要使用卷曲。对于大多数C#程序员来说,它与Unix-y相去甚远。作为一项规则,它将需要某种命令行转义约定,这也不是可移植的。不欢迎。

我认为在您的错误报告中以纯文本形式提供确切的HTTP调用/请求序列没有错。

  1. 任何人都可以用完全与语言无关的方式阅读它。
  2. 剪切和粘贴碎片相对容易尝试。
  3. 如果有人对您的错误报告感兴趣,那么编写一个小工具将其转换为C#可以处理的内容,或者Powershell,甚至卷曲都很容易。
  4. [碰巧我在Windows中使用C#,curl甚至wget非常开心,但我的回答很明显。]