2012-09-13 2 views
0

가능한 중복 :
ASP.NET web api: documenting/specifying a serviceASPNET의 웹 API - 데이터 계약 및 운영

내가 Asp.net 웹 API에 새로운 해요. WSDL 문서가 서비스에 대한 요청과 응답에 필요한 모든 스키마를 포함하는 SOAP 기반 애플리케이션과는 달리 웹 API의 입력과 출력에 대한 공식적인 정의는 없다. 나는 WCF에서의 나의 과거 경험으로 인해이 개념에 매우 익숙하다.

클라이언트가 이러한 API를 어떻게 소비하는지 어떻게 알 수 있습니까? '예제'를 제공해야합니까?

답변

1

당신의 최선의 방법은 ASP.NET 웹 API 도움말 페이지 nuget 패키지 - http://nuget.org/packages/Microsoft.AspNet.WebApi.HelpPage에 대한 것입니다. 웹 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에 훨씬 더 가깝게 문서화되도록 설계되지 않았습니다.

1

ApiExplorer은 Asp.net Webapi로 이동하는 길입니다.

소모 클라이언트에게 노출 된 작업/계약에 대해 정확히 알릴 수있는 WSDL 또는 REST API에 대한 것이 없기 때문에. Webapi에는 API 문서를 생성하는 데 사용할 수있는 IApiExplorer가 있습니다