有关如何像老板一样使用 REST WebAPI 的文档

Documentation on how to use REST WebAPI like a boss

我已经介绍了一些方法,虽然 crystal 清楚它们应该如何使用,但我相信随着时间的推移,记忆会消失,我会站在那里就像一个白痴想知道为什么我在地球上没有提供任何帮助。

当我们使用 WCF 时,有 WSDL 文件。但我不知道 WebAPI 有任何相应的功能。通常我添加一个 Ping 这样我就可以在我的浏览器中输入 URL window .../Service.svc/Ping, 只是为了看看我的日期。

什么是直观且(希望公平)规范的方法?我在想 .../Help。有没有更好的方法?

只是推出帮助只会产生一个巨大的字符串(XML 或 JSON 格式),这不太像老板。没有序列化就无法很好地处理匿名类型。推出 object 类型的实体会断开连接。

我希望有一个关于如何使用调用的内置文档。当然,名称本身,还有哪些值被处理(我有一个案例 .../Donkey?scope={scope} 模式可以是 null all 我们虽然是 any,但花了一段时间才弄明白。)

您可以查看 Swashbuckle which would allow you to generate Swagger 您的 ASP.NET Web API 控制器的文档。

Anonymous types can't be well handled without serialization. pushing out object typed entity breaks the connection

您是否真的在您的 Web API 合同中公开了上述内容。我希望你不要。