【问题标题】:Customize the WebHttp Help Output in WCF在 WCF 中自定义 WebHttp 帮助输出
【发布时间】:2011-10-23 17:27:42
【问题描述】:

对于具有 webHttpBinding 和 helpEnabled="true" 的服务,帮助信息正在正确生成。想知道是否有可能以某种方式控制输出。以下是我想做的更改。

  1. 删除 JSON 帮助,因为该服务不支持 JSON 输出。拥有它可能会让用户感到困惑。至少,有办法输出一条说明不支持 JSON 的注释。
  2. 对于显示的示例回复,使用比“字符串内容”更好的示例,其中可以指定实际值样本。如果我可以提供用于序列化的对象作为示例,那就太好了。

【问题讨论】:

    标签: wcf wcf-rest


    【解决方案1】:

    无法自定义 WCF WebHttp 端点的帮助页面。但是,您可以将其替换为您自己的自定义页面。它很容易实现,但是要编写很多代码。下面的示例展示了如何为一个简单的服务做到这一点。

    public class StackOverflow_7005187
    {
        [DataContract]
        public class MyDC
        {
            [DataMember]
            public string str = "The string";
        }
        [ServiceContract]
        public interface ITest
        {
            [WebInvoke]
            string EchoString(string text);
            [WebGet]
            int Add(int x, int y);
            [WebInvoke]
            MyDC EchoDC(MyDC input);
            [WebGet(UriTemplate = "/help")]
            Message GetMainHelpPage();
            [WebGet(UriTemplate = "/help/operations/EchoDC")]
            Message GetOperationsEchoDCHelpPage();
            // help for other operations not implemented
        }
        public class Service : ITest
        {
            public string EchoString(string text)
            {
                return text;
            }
    
            public int Add(int x, int y)
            {
                return x + y;
            }
    
            public MyDC EchoDC(MyDC input)
            {
                return input;
            }
    
            public Message GetMainHelpPage()
            {
                string page = @"<!DOCTYPE html PUBLIC ""-//W3C//DTD XHTML 1.0 Transitional//EN"" ""http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"">
    <html xmlns=""http://www.w3.org/1999/xhtml"">
      <head>
        <title>Operations at http://localhost:8000/Service</title>
        <style>BODY { color: #000000; background-color: white; font-family: Verdana; margin-left: 0px; margin-top: 0px; } #content { margin-left: 30px; font-size: .70em; padding-bottom: 2em; } A:link { color: #336699; font-weight: bold; text-decoration: underline; } A:visited { color: #6699cc; font-weight: bold; text-decoration: underline; } A:active { color: #336699; font-weight: bold; text-decoration: underline; } .heading1 { background-color: #003366; border-bottom: #336699 6px solid; color: #ffffff; font-family: Tahoma; font-size: 26px; font-weight: normal;margin: 0em 0em 10px -20px; padding-bottom: 8px; padding-left: 30px;padding-top: 16px;} pre { font-size:small; background-color: #e5e5cc; padding: 5px; font-family: Courier New; margin-top: 0px; border: 1px #f0f0e0 solid; white-space: pre-wrap; white-space: -pre-wrap; word-wrap: break-word; } table { border-collapse: collapse; border-spacing: 0px; font-family: Verdana;} table th { border-right: 2px white solid; border-bottom: 2px white solid; font-weight: bold; background-color: #cecf9c;} table td { border-right: 2px white solid; border-bottom: 2px white solid; background-color: #e5e5cc;}</style>
      </head>
      <body>
        <div id=""content"">
          <p class=""heading1"">Operations at http://localhost:8000/Service</p>
          <p>This page describes the service operations at this endpoint.</p>
          <table>
            <tr>
              <th>Uri</th>
              <th>Method</th>
              <th>Description</th>
            </tr>
            <tr>
              <td>Add</td>
              <td title=""http://localhost:8000/Service/Add?x={X}&amp;y={Y}"">
                <a rel=""operation"" href=""help/operations/Add"">GET</a>
              </td>
              <td>Service at http://localhost:8000/Service/Add?x={X}&amp;y={Y}</td>
            </tr>
            <tr>
              <td>EchoDC</td>
              <td title=""http://localhost:8000/Service/EchoDC"">
                <a rel=""operation"" href=""help/operations/EchoDC"">POST</a>
              </td>
              <td>Service at http://localhost:8000/Service/EchoDC</td>
            </tr>
            <tr>
              <td>EchoString</td>
              <td title=""http://localhost:8000/Service/EchoString"">
                <a rel=""operation"" href=""help/operations/EchoString"">POST</a>
              </td>
              <td>Service at http://localhost:8000/Service/EchoString</td>
            </tr>
          </table>
        </div>
      </body>
    </html>";
                return WebOperationContext.Current.CreateStreamResponse(
                    new MemoryStream(Encoding.UTF8.GetBytes(page)),
                    "text/html");
            }
    
    
            public Message GetOperationsEchoDCHelpPage()
            {
                string page = @"<!DOCTYPE html PUBLIC ""-//W3C//DTD XHTML 1.0 Transitional//EN"" ""http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"">
    <html xmlns=""http://www.w3.org/1999/xhtml"">
      <head>
        <title>Reference for  http://localhost:8000/Service/EchoDC</title>
        <style>BODY { color: #000000; background-color: white; font-family: Verdana; margin-left: 0px; margin-top: 0px; } #content { margin-left: 30px; font-size: .70em; padding-bottom: 2em; } A:link { color: #336699; font-weight: bold; text-decoration: underline; } A:visited { color: #6699cc; font-weight: bold; text-decoration: underline; } A:active { color: #336699; font-weight: bold; text-decoration: underline; } .heading1 { background-color: #003366; border-bottom: #336699 6px solid; color: #ffffff; font-family: Tahoma; font-size: 26px; font-weight: normal;margin: 0em 0em 10px -20px; padding-bottom: 8px; padding-left: 30px;padding-top: 16px;} pre { font-size:small; background-color: #e5e5cc; padding: 5px; font-family: Courier New; margin-top: 0px; border: 1px #f0f0e0 solid; white-space: pre-wrap; white-space: -pre-wrap; word-wrap: break-word; } table { border-collapse: collapse; border-spacing: 0px; font-family: Verdana;} table th { border-right: 2px white solid; border-bottom: 2px white solid; font-weight: bold; background-color: #cecf9c;} table td { border-right: 2px white solid; border-bottom: 2px white solid; background-color: #e5e5cc;}</style>
      </head>
      <body>
        <div id=""content"">
          <p class=""heading1"">Reference for  http://localhost:8000/Service/EchoDC</p>
          <p></p>
          <p xmlns=""http://www.w3.org/1999/xhtml"">
            <b>Url: </b>
            <span class=""uri-template"">http://localhost:8000/Service/EchoDC</span>
          </p>
          <p xmlns=""http://www.w3.org/1999/xhtml"">
            <b>HTTP Method: </b>
            <span class=""method"">POST</span>
          </p>
          <table>
            <tr>
              <th>Message direction</th>
              <th>Format</th>
              <th>Body</th>
            </tr>
            <tr>
              <td>Request</td>
              <td>Xml</td>
              <td>
                <a href=""#request-xml"">Example</a></td>
            </tr>
            <tr>
              <td>Request</td>
              <td>Json</td>
              <td>
                <a href=""#request-json"">Example</a>
              </td>
            </tr>
            <tr>
              <td>Response</td>
              <td>Xml</td>
              <td>
                <a href=""#response-xml"">Example</a></td>
            </tr>
          </table>
          <p>
            <a name=""#request-xml"">The following is an example request Xml body:</a>
            <pre class=""request-xml"">&lt;StackOverflow_7005187.MyDC xmlns=""http://schemas.datacontract.org/2004/07/WcfForums""&gt;
      &lt;str&gt;This is a modified string content&lt;/str&gt;
    &lt;/StackOverflow_7005187.MyDC&gt;</pre>
          </p>
          <p>
            <a name=""#request-json"">The following is an example request Json body:</a>
            <pre class=""request-json"">{
        ""str"":""Some content in JSON""
    }</pre>
          </p>
          <p>
            <a name=""#response-xml"">The following is an example response Xml body:</a>
            <pre class=""response-xml"">&lt;StackOverflow_7005187.MyDC xmlns=""http://schemas.datacontract.org/2004/07/WcfForums""&gt;
      &lt;str&gt;Another modified XML content&lt;/str&gt;
    &lt;/StackOverflow_7005187.MyDC&gt;</pre>
          </p>
        </div>
      </body>
    </html>";
                return WebOperationContext.Current.CreateStreamResponse(
                    new MemoryStream(Encoding.UTF8.GetBytes(page)),
                    "text/html");
            }
        }
        public static void Test()
        {
            string baseAddress = "http://" + Environment.MachineName + ":8000/Service";
            ServiceHost host = new ServiceHost(typeof(Service), new Uri(baseAddress));
            host.AddServiceEndpoint(typeof(ITest), new WebHttpBinding(), "").Behaviors.Add(new WebHttpBehavior { HelpEnabled = false });
            host.Open();
            Console.WriteLine("Host opened");
    
            Console.Write("Press ENTER to close the host");
            Console.ReadLine();
            host.Close();
        }
    }
    

    【讨论】:

    • 感谢您抽出宝贵时间。完全定制并不是我想要的。我见过的另一种方法是检查回复消息并进行更改,这也不理想。正在寻找一种可以通过属性或配置来控制的方法。好像没有这种方法。
    • 嗯,我实际上无法让WebGet(UriTemplate = "/help") 为我们服务。我的服务中定义的其他 URI 工作正常,但不是那个。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2011-07-06
    • 1970-01-01
    • 1970-01-01
    • 2011-03-16
    • 1970-01-01
    相关资源
    最近更新 更多