2013-04-22 3 views
2

ASP.NET 웹 API에는 샘플 생성기가 포함 된 Nuget 도움말 페이지가 쉽게 설치되어 있습니다. 샘플 요청을 생성하고 표시하는 것은 쉽지만 예제 응답 (httpsampleresponses)을 표시하는 것이 쉽지 않으므로 개발자가 도움말 페이지를 볼 때 생성 된 응답의 예/정적/형식화되지 않은 예제를 볼 수 있습니다. 응답에서, 그러나 실제로 생성했다. 이전에 다른 프로젝트에서이 작업을 수행 한 적이 있지만 문제를 해결하는 방법을 찾지 못했습니다. MSDN's YAO has a good blog하지만 어떤 이유로 든 나를 성공으로 이끌어 줄 수는 없습니다.웹 API 도움말 샘플 - C#

온라인에서 읽어야 할 내용을 기반으로 라이브 작업을 보았을 때, config.SetSampleResponses() 설정과 관련하여 HelpPageConfig 파일을 올바르게 가져 오는 중입니다. SetSampleResponses() 메서드의 매개 변수를 설정하는 구성 파일을 발견했지만 아직 시도하지 않은 것은 작동 중입니다. 사용자 정의 유형을 작성하고 확장 메소드를 사용해야한다고 제안했지만 필요한 부분을 표시하고 표시하는 것은 아직 발생하지 않았습니다. 오류없이 컴파일 할 수는 있지만 생성 된 응답 샘플은 페이지에 표시되지 않습니다. SetSampleForType 조각을 사용하면 요청 섹션에 표시 할 섹션을 쉽게 얻을 수 있지만 문제가있는 부분은 응답 섹션입니다.

누구나 SetSampleResponses()를 사용하여 성공적으로이 작업을 수행했는지, 작동시키기 위해 명확하게 정의 할 수있는 트릭이 있습니까? 특정 제네릭 유형을 설정하고 그 작업을 수행하는 데 필요한 조언이 있습니까? 나는 이것이 정말 간단 뭔가해야 내가 그냥 일어날 수 있도록 클릭하고 있지 않다 생각하고

.... 잠재적 인 정보를

감사합니다 ... HelpPageConfig에

답변

1

SetSampleResponse 확장은 당신을 위해 샘플을 정적으로 정의하기위한 것입니다.

config.SetSampleResponse("\"Hello World!\"", new MediaTypeHeaderValue("application/json"), "Values", "Get", "id"); 

특정 유형의 생성 된 샘플을 찾고 있다면, 당신은 SetSampleObjects에게 서로 다른 유형의 샘플 오브젝트를 설정하고이 같은 객체가 특정 유형이 반환됩니다 모든 경우에 사용할 수 있도록 확장을 사용하여 시도해야 행동에서.

config.SetSampleObjects(new Dictionary<Type, object> 
     { 
      {typeof(string), "Hello World!"} 
     }); 

SetSampleResponse 확장을 사용하는 방법에 대한 구체적인 (코드) 세부 정보를 공유 할 수 있습니까?

+0

정적 인 응답에 대한 정보를 보내 주셔서 감사합니다. MVC4 코드에서 기본 값 컨트롤러 대신 도움말 컨트롤러를 사용하는 사용자 지정 구성이 있고 웹 API를 사용하는 곳에서 내 문제가 실제로 존재한다고 생각합니다. SetSampleObjects를 여러 가지 방법으로 시도했지만 아직 사용하지 못하고 있습니다 ... 요즘 시도 중 하나가 작동해야합니다 .... 답장을 보내 주셔서 다시 한번 감사드립니다! – user1258050