Aspnet Web Api - 数据合约和操作 [重复]答案

【问题标题】：Aspnet Web Api - data contract and operations [duplicate]Aspnet Web Api - 数据合约和操作 [重复]
【发布时间】：2012-09-13 08:43:09
【问题描述】：

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

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

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

【问题讨论】：

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

【解决方案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。

【讨论】：

【解决方案2】：

ApiExplorer 是使用 Asp.net Webapi 的方式。

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

【讨论】：