现有WCF项目配置REST API打造混合解决方案：后续操作及资源咨询

一、实用学习资源 #

• 微软官方文档：重点关注WCF REST编程模型、ASP.NET Web API与WCF集成的核心配置章节，涵盖契约属性、绑定配置、宿主部署等内容
• 书籍：《WCF编程（第4版）》中REST服务实现章节，《ASP.NET Web API 2实战》里的混合服务架构与跨API通信部分
• 社区教程：Stack Overflow上的WCF+Web API混合方案相关问答，可直接搜索关键词获取实战配置案例

二、WCF契约/服务适配REST配置 #

• 修改服务契约：在原有WCF契约方法上添加[WebGet]或[WebInvoke]属性，指定路由模板、请求方法和响应格式，示例：

  [ServiceContract]
  public interface IProductService
  {
      [WebGet(UriTemplate = "/products/{productId}", ResponseFormat = WebMessageFormat.Json)]
      Product GetProduct(string productId);
  
      [WebInvoke(UriTemplate = "/products", Method = "POST", RequestFormat = WebMessageFormat.Json)]
      bool AddProduct(Product product);
  }
  

• 配置服务绑定与终结点：在web.config的<system.serviceModel>节点下，替换原有绑定为webHttpBinding，并配置支持跨域的行为：

  <bindings>
      <webHttpBinding>
          <binding name="RestBinding" crossDomainScriptAccessEnabled="true"/>
      </webHttpBinding>
  </bindings>
  <behaviors>
      <endpointBehaviors>
          <behavior name="WebHttpBehavior">
              <webHttp helpEnabled="true"/>
          </behavior>
      </endpointBehaviors>
  </behaviors>
  <services>
      <service name="YourNamespace.ProductService">
          <endpoint address="" binding="webHttpBinding" bindingConfiguration="RestBinding"
                    contract="YourNamespace.IProductService" behaviorConfiguration="WebHttpBehavior"/>
      </service>
  </services>
  

• 启用REST行为：确保服务终结点关联WebHttpBehavior，开启帮助页便于调试

三、Web API与前端/其他API通信实现 #

• 前端调用Web API：前端通过fetch、axios等工具直接请求Web API路由，示例：

  // 获取产品列表
  axios.get('/api/products')
       .then(response => console.log(response.data))
       .catch(error => console.error(error));
  

• Web API调用其他外部API：在控制器中使用HttpClient发起请求，处理响应后返回给前端，示例：

  public class ProductController : ApiController
  {
      private readonly HttpClient _httpClient = new HttpClient();
  
      public async Task<IHttpActionResult> GetExternalProduct(int id)
      {
          var response = await _httpClient.GetAsync($"https://external-api.com/products/{id}");
          if (response.IsSuccessStatusCode)
          {
              var product = await response.Content.ReadAsAsync<Product>();
              return Ok(product);
          }
          return BadRequest("Failed to fetch external product");
      }
  }
  

四、已创建核心文件后的后续操作 #

• 完善WebApiConfig路由配置：确保Register方法中启用属性路由并配置默认路由：

  public static void Register(HttpConfiguration config)
  {
      // 启用属性路由
      config.MapHttpAttributeRoutes();
      // 配置默认路由
      config.Routes.MapHttpRoute(
          name: "DefaultApi",
          routeTemplate: "api/{controller}/{id}",
          defaults: new { id = RouteParameter.Optional }
      );
      // 可选：配置JSON序列化格式为驼峰命名
      config.Formatters.JsonFormatter.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();
  }
  

• 配置Global.asax初始化逻辑：在Application_Start方法中确保Web API初始化代码执行，同时保留WCF服务的初始化逻辑（如有）：

  protected void Application_Start()
  {
      // 初始化Web API
      WebApiConfig.Register(GlobalConfiguration.Configuration);
      // 初始化WCF服务（如果是自托管或需要手动启动）
      // ServiceHost host = new ServiceHost(typeof(ProductService));
      // host.Open();
  }
  

• 调整宿主环境配置：
  • IIS托管：确保应用程序池的.NET框架版本与项目匹配，启用集成管道模式
  • 自托管：在宿主代码中添加WCF REST终结点的注册逻辑
• 配置跨域支持：如果前端与服务跨域，先安装Microsoft.AspNet.WebApi.Cors包，再在WebApiConfig中启用CORS：

  config.EnableCors(new EnableCorsAttribute("https://your-frontend-domain.com", "*", "*"));
  

• 测试验证：
  • 用Postman/curl测试WCF REST终结点和Web API接口，检查响应格式、状态码是否正确
  • 验证前端调用、Web API调用外部API的流程是否通畅
• 错误处理与日志：
  • 添加Web API全局异常过滤器，统一处理异常并返回标准错误响应
  • 配置WCF的错误日志，开发环境可开启includeExceptionDetailInFaults便于调试（生产环境关闭）
  • 集成日志框架（如NLog、Serilog）记录请求、响应及异常信息，便于排查问题

内容的提问来源于stack exchange，提问作者iris