如何修改WCF/REST或JSON服务的帮助页面？

可行，你可以通过两种核心方式修改默认的帮助页面，移除不需要的内容：

方法一：自定义HelpPageProvider #

• 创建一个继承自DefaultHelpPageProvider的类，重写GenerateHelpPage方法。在这个方法里，你可以获取默认生成的HTML内容，通过字符串处理（比如正则替换、DOM操作）移除不需要的模块（比如示例请求/响应、特定说明文本）。

  public class CustomHelpPageProvider : DefaultHelpPageProvider
  {
      public override string GenerateHelpPage(ServiceEndpoint endpoint)
      {
          string originalHtml = base.GenerateHelpPage(endpoint);
          // 这里添加逻辑移除不需要的内容，比如用正则删除某段HTML
          string modifiedHtml = Regex.Replace(originalHtml, @"<div class=""example-request"">.*?</div>", "", RegexOptions.Singleline);
          return modifiedHtml;
      }
  }
  

• 在web.config中配置使用这个自定义Provider：

  <system.serviceModel>
    <behaviors>
      <endpointBehaviors>
        <behavior>
          <webHttp helpEnabled="true" helpPageProviderType="YourNamespace.CustomHelpPageProvider, YourAssemblyName"/>
        </behavior>
      </endpointBehaviors>
    </behaviors>
  </system.serviceModel>
  

方法二：替换默认帮助页面模板 #

• 提取WCF默认的帮助页面模板：可以通过反编译System.ServiceModel.Web程序集（位于C:\Windows\Microsoft.NET\Framework\v4.0.30319）找到默认的HTML模板字符串，或者使用工具导出ServiceModelMetadataUtility.exe中的相关资源。
• 修改模板内容：复制模板后，直接删除不需要的HTML区块（比如多余的说明文字、示例代码区域），保留动态内容的占位符（比如{serviceDescription}、{endpointList}）以保证API信息正常展示。
• 指定自定义帮助页面：在web.config中配置helpPageUrl指向你修改后的页面，或者通过自定义IHttpHandler拦截帮助页面请求，返回修改后的HTML内容：

  <webHttp helpEnabled="true" helpPageUrl="~/CustomHelpPage.html"/>
  

注意事项 #

• 自定义Provider时，要确保字符串处理逻辑能兼容不同的服务结构，避免破坏页面的正常渲染。
• 替换模板时，不要删除动态占位符，否则会丢失API的具体接口信息。

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