2011-08-24 18 views
5

Quali sono le opzioni per documentare un ServiceStack basa i servizi Web e non sto parlando di una stringa di una riga.Documentazione dei servizi Web ServiceStack

mi piacerebbe essere in grado di documentare, in dettaglio (che può essere lungo), restituire i tipi, le possibili risposte HTTP, aggiungere esempi dettagliati ecc

Esiste un supporto per questo a ServiceStack (non potevo' lo trovo)? Se nessuno ha risolto il problema in qualche altro modo.

risposta

4

È possibile fornire descrizioni di metadati per ciascuno dei servizi Web attribuendo i DTO di richiesta con gli attributi [Api] e [ApiMember]. Queste informazioni verranno visualizzate sulle pagine dei metadati dinamici.

Un'altra opzione è semplicemente creare la propria pagina HTML dinamica, che ServiceStack consente di eseguire semplicemente restituendo una stringa (contenente il markup html). Se si segue questa rotta, è possibile accedere ai metadati dei tipi di servizio con la proprietà globale EndpointHost.ServiceOperations.

anche se in modo dinamico la generazione di HTML con C# non è la vostra preferenza si può anche generare html utilizzando il built-in Razor Markdown format che rende la generazione di HTML abbastanza piacevole :)

+0

Come viene utilizzato l'attributo [ApiMember]? Vedo che se si accede all'API root e si naviga verso l'endpoint utilizzando il DTO, viene visualizzata l'informazione [Api] ... ma non sono riuscito a trovare il luogo in cui è stato utilizzato il materiale [ApiMember]. –