Aspnet Web Api - 数据合同和运营

时间:2012-09-13 08:43:09

标签: asp.net-mvc wcf asp.net-web-api

  

可能重复:
  ASP.NET web api: documenting/specifying a service

我是Asp.net Web API的新手。似乎没有Web API的输入和输出的正式定义,不像基于SOAP的WSDL文档包含请求和响应服务所需的所有模式。由于我过去在WCF的经历,我对这个概念非常熟悉。

客户端如何知道如何使用这些API?我们需要提供“示例”吗?

2 个答案:

答案 0 :(得分:1)

我认为您最好的选择是使用ASP.NET Web API帮助页面nuget包 - http://nuget.org/packages/Microsoft.AspNet.WebApi.HelpPage。它是在Web API RTM发布的同一天发布的,这就是为什么网上没有关于它的信息,以及为什么大多数人仍会指向IApiExplorer

来自MSFT的Yao Huang介绍了如何使用它的非常好的介绍 - http://blogs.msdn.com/b/yaohuang1/archive/2012/08/15/introducing-the-asp-net-web-api-help-page-preview.aspx

它不像IApiExplorer那样低(它在其上运行)并且对于大多数用例而言应该更好。

另外,如果要构建REST服务不要使用WSDL 。它不是为记录REST服务而设计的,而是更接近RPC类型的API。

答案 1 :(得分:1)

ApiExplorer是Asp.net Webapi的方法。

由于REST Apis没有WSDL或任何东西可以准确地告诉消费客户端暴露的操作/合同。 Webapi有IApiExplorer,可用于生成api的文档