4

내 웹 API의 도움말 페이지에서 없음 이외의 리소스 설명에 대한 내용을 표시하는 방법을 파악하는 데 문제가 있습니다. IHttpActionResult가 링크 된 다음 "없음"이 있습니다. 그 후. HelpPageConfig.cs에 config.SetActualResponseType(typeof(ComplexType), "Controller", "Action");을 추가하여 예제를 만들었습니다. 내 컨트롤러는 다음과 같습니다.웹 API 도움말 페이지의 리소스 설명에 "없음"이 표시됩니다.

/// <summary> 
/// My description 
/// </summary> 
[Route("MyRoute")] 
public IHttpActionResult Get() 
{ 
    try 
    { 
     //throw new Exception("TEST"); 
     return Ok(returnValue); 
    } 
    catch (Exception ex) 
    { 
     *Company Log Method* 
     return NotFound(); 
    } 
} 

HelpPageConfig.cs 또는 다른 곳에서 누락 된 부분을 모르겠습니다. 어쩌면 신선한 눈이 무언가를 잡을 수 있습니다. 도움에 미리 감사드립니다! 예를 들어, -

답변

7

내 컨트롤러 상단에 using System.Web.Http.Description;을 넣은 후 내 작업보다 위에 [ResponseType(typeof(MyModel))]을 추가해야했습니다. 이제 IHttpActionResult 및 "None"대신 내 모델에 대한 설명을 얻습니다.

0

나는 지역 \ HelpPage의 다양한 지점을 가리키는 휴식로 시작하는 것 (이것은 아마도 코멘트가 될한다고하지만 난 아직 충분히 담당자가 없습니다) XmlDocumentationProvider - 모든 단서를 제공하는지 확인합니다. 아무것도 내게 도약.

XML 도움말 파일이 출력되는 위치를 변경했으며 XmlDocumentationProvider에 전달 된 문서 경로를 업데이트하지 않았습니까? 경로는 속성 페이지 - 출력 XML 문서 파일을 통해 설정됩니다.

+0

어디서 설정해야할지 모르지만, 중단 점 설정에 대한 유용한 조언. XML 파일까지 HelpPageConfig.cs와 Properties의 경로는 동일하며 프로젝트에 포함 시켰으므로 그렇게하지 않았습니다. – dkiefer