可能重複:
ASP.NET web api: documenting/specifying a serviceASPNET網絡API - 數據契約和操作
我新的Asp.net的Web API。似乎沒有關於Web API的輸入和輸出的正式定義,這與基於SOAP的WSDL文檔包含對服務的請求和響應所需的所有模式不同。由於我過去在WCF的經歷,我對這個概念非常熟悉。
客戶端如何知道如何使用這些API?我們是否需要提供「示例」?
可能重複:
ASP.NET web api: documenting/specifying a serviceASPNET網絡API - 數據契約和操作
我新的Asp.net的Web API。似乎沒有關於Web API的輸入和輸出的正式定義,這與基於SOAP的WSDL文檔包含對服務的請求和響應所需的所有模式不同。由於我過去在WCF的經歷,我對這個概念非常熟悉。
客戶端如何知道如何使用這些API?我們是否需要提供「示例」?
我認爲你最好的選擇是去ASP.NET Web API幫助頁面nuget包 - http://nuget.org/packages/Microsoft.AspNet.WebApi.HelpPage。它是在Web API RTM發佈的同一天發佈的,這就是爲什麼網上沒有太多關於它的信息,爲什麼大多數人仍然會指您IApiExplorer
。
有一個非常好的介紹截屏由姚黃從MSFT有關如何使用它 - 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。
ApiExplorer是去Asp.net Webapi的路。
由於REST Apis沒有WSDL或任何可以準確告訴消費客戶有關操作/合同暴露的信息。 Webapi有IApiExplorer,可用於生成您的api文檔