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

时间:2016-01-05 21:17:50

标签: wcf rest asp.net-web-api documentation

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

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

什么是直观的(希望是公平的)规范方法?我在想 ... /帮助。还有更好的方法吗?

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

我希望有一个关于如何使用这些调用的内置文档。当然,名称本身,以及处理的值(我有一个 ... / Donkey?scope = {scope} 模式的情况可能 null 所有,我们虽然它是任何,但需要一段时间来弄明白。)

1 个答案:

答案 0 :(得分:1)

您可以结帐Swashbuckle,这样您就可以为ASP.NET Web API控制器生成Swagger文档。

  

没有序列化,无法很好地处理匿名类型。推动   out对象类型实体断开连接

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