13

我得到了一些关于 ASP Web API 的信息。它看起来像是 Web 服务的好东西，但是如何像 WCF 服务那样为我的 API 创建像 WSDL 这样的东西呢？3d 方组件如何使用我的服务？或者我需要手动描述我的每个方法？

4

4 回答 4

16

至于好不好看，那是个人意见，你试试看吧（我个人很喜欢）

就 WDSL 而言，Web API 是一个 RESTful API，不是基于 SOAP，因此没有 WSDL 支持，WCF 支持 REST 和 SOAP，因此如果您需要 SOAP 服务和 WSDL，这可能是一个更好的选择，ScottGu 关于 API 的最新博客非常有趣，并且有教程链接（WSDL 生成问题也在评论中得到解答）

http://weblogs.asp.net/scottgu/archive/2012/02/23/asp-net-web-api-part-1.aspx

于 2012-02-29T13:34:55.357 回答
5

WebApi 中没有 SOAP 或 WSDL 支持。如果你喜欢 WebApi，你就会喜欢同时支持 REST 和 SOAP 的ServiceStack 。您甚至可以为 REST 服务生成带有服务堆栈的 WSDL。

于 2013-11-19T13:45:31.687 回答
4

这与 OP 可能打算询问的情况略有不同，但更广泛地解释了“如何像 WCF 服务那样为我的 API 创建类似 WSDL 的东西？”

我有一种情况，我们无法公开 WCF 服务，唯一的选择是 WebAPI。然而，使用 API 的一方只支持 SOAP/WSDL，并且有一个预定义的 WSDL，他们需要集成商来托管和遵守。

提供 WSDL 文件

一个 WebAPI 操作为 WSDL 文件提供服务，该文件只是一个静态 WSDL 文件。此方法不支持查询部分 WSDL。因此客户端必须使用 URL 请求yourdomain.com/SomeRoot/SomeApiPath?wsdl，之后的任何查询字符串参数都将被忽略，并提供完整的 WSDL。该参数[FromUri] string wsdl确保为其中包含的 URL 选择此操作?wsdl，但其中没有任何值。

public IHttpActionResult SomeApiPath([FromUri] string wsdl)
    {
        System.IO.FileStream wsdlFileStream = System.IO.File.OpenRead(System.Web.HttpContext.Current.Server.MapPath("~/Content/SomeThing.wsdl"));
        var response = new HttpResponseMessage(HttpStatusCode.OK);
        response.Content = new StreamContent(wsdlFileStream);
        response.Content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("text/xml");
        return ResponseMessage(response);
    }

这意味着您的 API 操作方法需要处理和响应 XML SOAP 请求。

处理 SOAP 请求

虽然 WebAPI 可以将参数绑定到 XML 请求，但我选择在我的操作中没有参数，而是Request.Content.ReadAsStringAsync()在每个操作中使用以获取请求正文（即 XML SOAP 请求），然后使用 XML to LINQ 对其进行解析以获取特定值我需要。这使我免于尝试对 XML 可序列化 POCO 进行逆向工程以匹配 WSDL 定义的请求结构。

创建 SOAP 响应

您可以在 Visual Studio 中使用 Svcutil.exe 等工具来生成 XML 可序列化 POCO。由于我们不使用 WCF，因此您不会使用完整的服务合同，而只需提取 C# 类 POCO，以便您可以使用数据填充它们并将它们序列化为 XML 以创建响应。但是，创建具有所有正确名称空间引用的 SOAP 信封极具挑战性。我在某些地方进行了修改，实际上使用了字符串连接而不是 XML 序列化。序列化为 XML 字符串，并在 StringContent 响应中返回：

return ResponseMessage(
       new HttpResponseMessage(HttpStatusCode.OK)
       {
           Content = new StringContent(soapResponseBody, System.Text.Encoding.UTF8, "text/xml")
       });

注意：即使是异常也必须被捕获并转换为 XML 作为 SOAP 信封内的 SOAP 故障。

以上所有可怕的变通方法都证明，如果您绝对必须支持 SOAP，那么使用 WebAPI 之外的任何东西都会容易得多。我喜欢 WebAPI，但是当你必须与另一个只支持 SOAP/WSDL 的系统集成时，它肯定不是适合这项工作的工具。当您没有其他选择时，我提供以上内容作为解决此问题的方法的摘要，但建议使用除 WebAPI 之外的支持 SOAP 的框架。您肯定会遇到上述问题，并且需要在 XML 序列化和 XML 模式方面拥有丰富的经验才能了解如何解决这些问题。

有人拥有预定义的 WSDL 并要求其他人实现公开该 WSDL 的服务也很奇怪/很少见。换句话说，他们作为客户端从他们这边集成，而您是主机，但他们决定了请求的结构。通常情况正好相反，有人使用预定义的 WSDL 公开了一项服务，而您必须实现一个客户端来使用它，这通常要容易得多。

于 2015-01-26T23:03:53.490 回答
1

ServiceStack是一个很好的替代方案，它包括对 SOAP 的内置支持，它可以从您的服务定义中自动生成 WSDL、XSD 和模式描述，这些可以从您自动生成的元数据页面中获得。

添加 ServiceStack 参考

ServiceStack 还为 WCF 的Add Service Reference提供了更好的替代方案，它可以使用Add ServiceStack Reference仅从 URL 生成类型化 API 。

相对于 WCF 的优势

  • Simple使用一个小的 T4 模板来保存生成的 POCO 类型。更新就像重新运行 T4 模板一样简单
  • Versatile Clean DTO 适用于所有 JSON、XML、JSV、MsgPack 和 ProtoBuf通用服务客户端
  • 可重用生成的 DTO 不与任何端点或格式耦合。默认值既是部分的又是虚拟的，以最大限度地重复使用
  • 与 RPC 服务相比，基于弹性消息传递的服务具有许多优势
  • 灵活的 DTO 生成是可定制的，服务器和客户端可以覆盖内置默认值
  • 在 DTO 上注释的集成丰富服务元数据，外部访问时排除内部服务
于 2014-09-29T04:04:01.550 回答