如何:禁用 Web 服务的服务帮助页

本主题专门介绍一项旧有技术。现在应通过使用以下链接来创建 XML Web 服务和 XML Web 服务客户端: Windows Communication Foundation.

在没有任何参数的情况下,使用 Web 浏览器导航到 Web 服务的 URL 可生成 HTML 帮助页(如果已启用该页,启用该页是服务器中 machine.config 文件的默认设置)。在使用 ASP.NET 创建的 XML Web services 的配置选项 中对服务帮助页及其配置进行了进一步讨论。

禁用单个 Web 应用程序的服务帮助页

  1. 使用自己喜爱的编辑器打开 Web 应用程序根目录中的 Web.config 文件。(如果 Web.config 文件不存在,请创建一个。)

  2. 修改 Web.config 的 webServices 部分,以显式移除 Documentation 协议。

    <webServices>
         <protocols>
           <remove name="Documentation" />
         </protocols>
    </webServices>
    
  3. 保存 Web.config。

    当下次向该 Web 应用程序承载的 Web 服务发出请求时,此配置更改将生效。

    2tyf2t8t.note(zh-cn,VS.100).gif注意:
    移除 Documentation 协议后,还会为该 Web 应用程序中的所有 Web 服务禁用 WSDL 文件生成。这会阻止客户端生成代理类,除非创建自定义的 WSDL 文件并将其提供给客户端。若要为 Web 应用程序内的 Web 服务保留 WSDL 文件生成功能,但不提供任何与 Web 服务有关且可供人类识别的信息,可以向该 Web 应用程序的 Web.config 文件中添加一个 <wsdlHelpGenerator> 元素,并将 href 特性设置为已创建的空白 HTML 页。下面的代码示例摘自 Web.config 文件,它将服务帮助页设置为 docs 文件夹中的 MyBlank.htm 文件,该文件夹位于 Web.config 文件所在的文件夹下。

    <webServices>
       <wsdlHelpGenerator href="docs/MyBlank.htm"/>
    </webServices>
    

另请参见

任务

如何:禁用 Web 服务的协议支持
如何:为 XML Web services 启用发现

概念

使用 ASP.NET 创建的 XML Web services 的配置选项
部署 XML Web services

其他资源

使用 ASP.NET 的 XML Web services