Как документировать веб-сервис WCF в технической спецификации?

Question

За исключением случаев добавления WDSL в техническую спецификацию, каковы рекомендуемые способы документирования веб-службы WCF перед началом кодирования?

Answer 1

Недавно мы опубликовали интерфейс SOAP на основе WCF, с которым могут интегрироваться третьи стороны. Для каждого метода мы предоставили следующее:

• Имя метода
• Пример запроса (дамп проводного формата)
• Запрос параметров объяснения
• Пример ответа (дамп проводного формата)
• Запрос параметров объяснения
• Предостережения (гочас)
• История

Мы также предоставляем WSDL. Вы можете использовать Microsoft Disco.exe для этого. См. Также связанный вопрос о получении WSDL .

Answer 2

Microsoft документирует некоторые службы WCF в MSDN. Я думаю, что вы можете получить некоторые идеи по следующим ссылкам:

• Обзор службы Windows Communication Foundation Role
  • RoleService
• Обзор службы профиля Windows Communication Foundation
  • ProfileService
• Обзор службы проверки подлинности Windows Communication Foundation
  • AuthenticationService

Answer 3

Документируйте интерфейс контракта так же, как любой другой интерфейс. Опишите операции, предварительные условия, постусловия, причины возникновения ошибки и т. Д.

Answer 4

• Опишите конечные точки службы и доступные протоколы / привязку. например Https, RESTful?
• Функции безопасности, аутентификация, авторизация и шифрование.
• Объясните варианты использования параметров в договоре эксплуатации.
• Хостинг, IIS, WindowsService или Консольное приложение.
• Предоставление услуги.

Answer 5

Кроме того, если вы используете документ MessageContracts, почему вы их используете ... поверьте мне, вы удивитесь, почему вы это сделали:)