Comment documenter un service Web WCF dans une spécification technique?

Question

Outre le fait de coller un fichier WDSL dans la spécification technique, quels sont les moyens recommandés pour documenter un service Web WCF avant de commencer le codage?

Answer 1

Nous avons récemment publié une interface SOAP à base de WCF pour des tiers d'intégrer contre. Pour chaque méthode, nous avons fourni les éléments suivants:

• Nom de la méthode
• Exemple de demande (vidage de format fil)
• paramètres de demande d'explication
• exemple de réponse (vidage de format fil)
• paramètres de demande d'explication
• Avertissements (getchas)
• Historique

Nous fournissons également le WSDL. Vous pouvez utiliser Microsoft Disco.exe pour cela. Voir aussi une question connexe à propos de obtaining the WSDL.

Answer 2

Documentez l'interface de contrat comme vous le feriez pour toute autre interface. Décrivez les opérations, les pré-conditions, les post-conditions, les raisons de lancer une erreur, etc.

Answer 3

De même, si vous utilisez le document MessageContracts, pourquoi est-ce que vous les utilisez ... croyez-moi, vous vous demanderez pourquoi vous l'avez fait :)

Answer 4

• Décrivez les points de terminaison de service et les protocoles/liaisons disponibles. par exemple. Https, RESTful?
• Fonctions de sécurité, authentification, autorisation et cryptage.
• Expliquer les cas d'utilisation des paramètres dans le contrat de fonctionnement.
• Hébergement, IIS, WindowsService ou application console.
• Instanciation du service.

Answer 5

Microsoft documente certains services WCF dans MSDN. Je pense que vous pouvez obtenir quelques idées à partir des liens suivants:

• Windows Communication Foundation Role Service Overview
  • RoleService
• Windows Communication Foundation Profile Service Overview
  • ProfileService
• Windows Communication Foundation Authentication Service Overview
  • AuthenticationService