2011-08-24 14 views
5

¿Cuáles son las opciones para documentar un servicio web base de ServiceStack y no estoy hablando de una cadena de una línea.Servicio de documentación Servicios web de plataforma

Me gustaría ser capaz de documentar en detalle (que puede ser de largo), los tipos, las posibles respuestas HTTP volver, añadir ejemplos detallados etc.

¿Hay alguna ayuda para esto en ServiceStack (no pude t lo encuentra)? Si no, nadie ha resuelto el problema de alguna otra manera.

Respuesta

4

Puede proporcionar descripciones de metadatos para cada uno de sus servicios web atribuyendo sus DTO de solicitud con los atributos [Api] y [ApiMember]. Esta información se mostrará en las páginas dinámicas de metadatos.

Otra opción es simplemente crear su propia página dinámica html, que ServiceStack le permite hacer simplemente devolviendo una cadena (que contiene su marcado html). Si sigue esta ruta, puede acceder a los metadatos de Tipos de servicio con la propiedad global EndpointHost.ServiceOperations.

Además, si la generación dinámica de HTML con C# no es su preferencia también puede generar html usando el incorporado en Razor Markdown format lo que hace que la generación de html bastante agradable :)

+0

¿Cómo se usa el atributo [ApiMember]? Veo si vas a la aplicación raíz y navegas al punto final usando el DTO, se muestra la información [Api] ... pero no pude encontrar dónde se estaba utilizando el material [ApiMember]. –