ASP.NET 웹 API 도움말 컨트롤러에서 Xml 주석을 사용하는 페이지 설명서

Question

ASP.NET Web API Help Page 패키지를 설치했으며이 태그를 사용하여 이미 API 주석을 사용하여 API 컨트롤러 동작에 대한 설명서를 생성하고 싶습니다.

article on Yao's MSDN blog에서 XML 메모를 기반으로 문서를 생성하는 방법에 대해 설명합니다.

그러나 의 등록 방법에서 SetDocumentationProvider 메서드는 Xml 설명서 파일의 실제 경로로 구성된 XmlDocumentationProvider의 인스턴스를 필요로합니다.

다른 방법이 있습니까? Xml 문서 파일을 가리켜 야 할 이유가 명확하지 않습니다. 당신이 당신의 프로젝트를 컴파일 할 때 생성됩니다

감사

Answer 1

XmlDocumentationProvider이 (당신의 XML 코드 주석을 가진) XML 파일을 찾고 있습니다. 프로젝트 생성 -> 빌드 -> 출력으로 이동하여 생성을 활성화 할 수 있습니다. XML 문서 파일의 확인란을 선택하십시오.

Answer 2

그래도 문제가 해결되지 않으면 아래 단계를 참조하십시오.

1 단계 - 속성 프로젝트 속성 페이지를 구축하고 문서

에 대한 XML 출력을 설정 -

// GET api/documentation 
/// <summary> 
/// This is how we create a documentation 
/// </summary> 
/// <returns></returns> 
public IEnumerable<string> Get() 

2 단계 컨트롤러 수준에 코멘트를 추가 3 단계 - HelpPage 구성

문서 xml 파일을 사용하도록 HelpPageConfig를 설정하려면 ~\Areas\HelpPage\HelpPageConfig.cs으로 이동하십시오.

기본적으로 config.SetDocumentationProvider 문은 주석 처리되어 있습니다. 그 문을 사용하여, 우리의 XML 파일에 DocumentationProvider의 위치를 ​​가리 킵니다 :

public static void Register(HttpConfiguration config) 
{ 
    // Uncomment the following to use the documentation from XML documentation file. 
    config.SetDocumentationProvider(
      new XmlDocumentationProvider(
       HttpContext.Current.Server.MapPath("~/App_Data/Documentation.xml"))); 
} 

편집 :

VS2013에서 만든 새 웹 API 2.2 프로젝트의 HelpPageConfig의 위치는 ~\Areas\HelpPage\App_Start\HelpPageConfig.cs

Answer 3

이 질문에 대한 답변은 알고 있지만 도움이 될만한 경우 IHttpActionResult에 대한 문서를위한 해결책을 찾고 있기 때문에이 페이지를 발견했습니다

How to add IHttpActionResult into documentation