2011-08-24 21 views
5

Jakie są opcje dokumentowania usługi ServiceStack w oparciu o usługi sieciowe i nie mówię o łańcuchu jednoliniowym.Dokumentowanie usług sieci Web ServiceStack

Chciałbym być w stanie udokumentować, szczegółowo (co może być długa), powrót rodzajów, możliwych odpowiedzi HTTP, należy dodać szczegółowe przykłady itp

Czy istnieje wsparcie dla tego w ServiceStack (Nie mogłem t go znaleźć)? Jeśli nie, ktoś rozwiązał problem w inny sposób.

Odpowiedz

4

Możesz podać opisy metadanych dla każdego ze swoich serwisów internetowych, przypisując swoje DTO z wnioskiem atrybutami [Api] i [ApiMember]. Informacje te będą wyświetlane na dynamicznych stronach metadanych.

Inną opcją jest po prostu utworzenie własnej dynamicznej strony html, którą ServiceStack umożliwia, po prostu zwracając ciąg znaków (zawierający znaczniki HTML). Jeśli przejdziesz tę trasę, uzyskasz dostęp do metadanych Typy usług z globalną właściwością EndpointHost.ServiceOperations.

Także jeśli dynamicznie generować html z C# nie jest twoje preferencje można również generować html za pomocą wbudowanego w Razor Markdown format co sprawia generującego html całkiem przyjemny :)

+0

W jaki sposób używany jest atrybut [ApiMember]? Widzę, że jeśli przejdziesz do głównego api i przejdziesz do punktu końcowego za pomocą DTO, informacja [Api] zostanie pokazana ... ale nie mogłam znaleźć miejsca, w którym użyto rzeczy [ApiMember]. –

Powiązane problemy