WebApi 도움말 페이지 설명

WebApi 도움말 페이지 설명

---

Webapi헬퍼 페이지와 소개 단락 에서 메소드 설명을 채우는 것은 무엇입니까 ?

---

이 기사 에 따르면 XML 문서 주석을 사용하여 문서를 작성할 수 있습니다. 이 기능을 사용하려면 Areas / HelpPage / App_Start / HelpPageConfig.cs 파일을 열고 다음 행의 주석 처리를 제거하십시오.

config.SetDocumentationProvider(new XmlDocumentationProvider(
    HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));

이제 XML 문서를 활성화합니다. 솔루션 탐색기에서 프로젝트를 마우스 오른쪽 단추로 클릭하고 속성을 선택합니다. 빌드 페이지를 선택하십시오.

출력에서 XML 문서 파일을 확인하십시오. 편집 상자에 "App_Data / XmlDocument.xml"을 입력합니다.

컨트롤러 메소드에 문서 주석을 추가하십시오. 예를 들면 :

/// <summary>
/// Gets some very important data from the server.
/// </summary>
public IEnumerable<string> Get()
{
    return new string[] { "value1", "value2" };
}

/// <summary>
/// Looks up some data by ID.
/// </summary>
/// <param name="id">The ID of the data.</param>
public string Get(int id)
{
    return "value";
}

---

설명을 보려면 다음을 따라야합니다.

1. 고객 컨트롤러의 모든 작업 에는 XML 문서 가 있어야합니다.
2. 컨트롤러가 포함 된 프로젝트의 속성을 열고 다음과 같이 XML 문서를 활성화합니다.

3. HelpPageConfig 클래스 의 Register 메서드 (Areas / HelpPage / App_Start / HelpPageConfig.cs)에서 19 행의 주석 처리를 제거하고 다음과 같이 파일 경로를 변경하는 것을 잊지 마십시오.

   config.SetDocumentationProvider(new XmlDocumentationProvider(
       HttpContext.Current.Server.MapPath("~/App_Data/MvcApplication4.XML"))
   );
   

이 모든 작업을 수행해야합니다. 마지막으로 App_Data에서 생성 된 파일을 프로젝트에 포함하여 파일이 프로덕션에 배포되도록합니다.

---

VB.NET을 사용하는 사람들에게는 조금 다르게해야 할 것 같습니다.

Web API 프로젝트 에 대한 " 컴파일 "탭 (빌드 탭이 없음)으로 이동 한 다음 " XML 문서 파일 생성 "확인란이 선택되어 있는지 확인해야합니다.

출력은 실제로 /bin/{projectName}.xml 에 저장되므로 이제 SetDocumentationProvider" ~ / bin / {projectname} .xml " 경로를 가리 키도록 호출 을 변경해야합니다 (분명히 {projectname}을 실제 프로젝트로 바꾸십시오). 이름).

냄새가 나는 것 같으니 다른 방법을 찾으면 알려주세요.

참조 URL : https://stackoverflow.com/questions/24284413/webapi-help-page-description