如何在技术规范中记录WCF web服务

本文关键字：WCF web 服务 记录 技术规范 | 更新日期: 2023-09-27 17:48:52

除了在技术规范中粘贴WDSL之外，在开始编码之前，建议使用哪些方法来记录WCF web服务？

如何在技术规范中记录WCF web服务

我们最近发布了一个基于WCF的SOAP接口，供第三方进行集成。对于每种方法，我们都提供了以下内容：

  • 方法名称
  • 请求示例（导线格式转储）
  • 请求参数说明
  • 响应示例（导线格式转储）
  • 请求参数说明
  • 注意事项（gotchas）
  • 历史

我们还提供WSDL。您可能需要使用Microsoft的Disco.exe来执行此操作。另请参阅有关获取WSDL的相关问题。

像记录任何其他接口一样记录合同接口。描述操作、先决条件、后决条件、引发故障的原因等。

此外，如果您正在使用MessageContracts文档，说明您为什么要使用它们。。。相信我，你会想知道你为什么这么做：）

  • 描述服务端点和可用的协议/绑定。例如Https、RESTful
  • 安全功能、身份验证、授权和加密
  • 解释操作合同中参数的用例
  • 主机、IIS、WindowsService或控制台应用程序
  • 服务的实例化
相关文章：