2011-08-24 2 views
5

ServiceStack 기반 웹 서비스를 문서화하기위한 옵션은 무엇이며 한 줄짜리 문자열을 말하는 것이 아닙니다.ServiceStack 웹 서비스 문서화

내가

가 ServiceStack이에 대한 지원이 있는가 등 상세한 예제를 추가, (긴 될 수있는) 구체적으로, 문서 유형, 가능한 HTTP 응답을 반환 할 수 있도록하고 싶습니다 (I '는 나오지 않았어 찾지 마라)? 누군가 다른 방법으로 문제를 해결하지 못했다면.

답변

4

요청 DTO를 [Api] 및 [ApiMember] 속성으로 표시하여 각 웹 서비스에 대한 메타 데이터 설명을 제공 할 수 있습니다. 이 정보는 동적 메타 데이터 페이지에 표시됩니다.

또 다른 옵션은 동적 HTML 페이지를 만드는 것입니다. ServiceStack에서는 문자열 (HTML 마크 업 포함)을 반환하여 처리 할 수 ​​있습니다. 이 경로를 선택하면 전역 EndpointHost.ServiceOperations 속성을 사용하여 서비스 유형 메타 데이터에 액세스 할 수 있습니다. 동적으로 C 번호와 HTML을 생성하는 경우에도

당신은 또한 사용하여 HTML을 생성 할 수 있습니다 선호하지 않습니다 내장 된 매우 적절한 HTML :

+0

[ApiMember] 속성은 어떻게 사용됩니까? 루트 api로 가서 DTO를 사용하여 끝점으로 이동하면 [Api] 정보가 표시됩니다 ... 그러나 [ApiMember]가 사용 된 위치를 찾을 수 없습니다. –