Documentation des services Web ServiceStack

Question

Quelles sont les options permettant de documenter un service Web de base ServiceStack et je ne parle pas d'une chaîne à une ligne.

Je voudrais être en mesure de documenter en détail (qui peut être long), les types de retour, les réponses HTTP possibles, ajouter des exemples détaillés, etc.

Y at-il favorable dans ServiceStack (je ne pourrais pas » t le trouver)? Si personne n'a résolu le problème d'une autre manière.

Answer 1

Vous pouvez fournir des descriptions de métadonnées pour chacun de vos services Web en attribuant vos DTO de requête avec les attributs [Api] et [ApiMember]. Ces informations seront affichées sur les pages de métadonnées dynamiques.

Une autre option consiste simplement à créer votre propre page html dynamique, ce que ServiceStack vous permet de faire en retournant simplement une chaîne (contenant votre balisage html). Si vous suivez cette route, vous pouvez accéder aux métadonnées des types de service avec la propriété globale EndpointHost.ServiceOperations.

également si dynamiquement générer html avec C# est pas votre préférence, vous pouvez également générer html en utilisant le haut-Razor Markdown format ce qui rend la génération html très agréable :)

Answer 2

Je réalise cette question est un couple ans, mais il est maintenant le support de Swagger pour les APIs de ServiceStack @https://github.com/ServiceStack/ServiceStack/wiki/Swagger-API