WCF Web HTTP サービスのヘルプページ

[アーティクル]
05/10/2023

.NET Framework 4.6.1 には、WCF WEB HTTP サービスの自動ヘルプページが用意されています。このヘルプページには、各操作の説明、要求と応答の形式、およびスキーマが一覧表示されます。この機能は、既定では無効になっています。ユーザーが WCF WEB HTTP サービスを参照し、URL の最後に "/Help" を追加する (http://localhost:8000/Customers/Help など) と、次のようなヘルプページが表示されます。

A browser with the WCF REST Help page open.

ヘルプページに一覧表示されているメソッドをユーザーがクリックすると、その操作の詳細を示すページが表示され、メッセージの形式や応答例など、そのメソッドの詳細が示されます。次の図は、メソッドのヘルプページの例です。

A browser with the WCF REST Help page details for the GetCustomers method open.

WCF Web HTTP ヘルプページの使用

DescriptionAttribute を使用して指定した場合は、WCF WEB HTTP ヘルプページに各操作の短い説明が表示されます。この属性は、適用される操作の短い説明を含む文字列を取得します。たとえば、次のコードでは、DescriptionAttribute を使用して短い説明を提供する方法を示しています。

[OperationContract]  
[WebGet(UriTemplate="/template1", BodyStyle = WebMessageBodyStyle.Bare)]  
[Description("Description for GET /template1")]  
SyndicationFeedFormatter GetTemplate1();

WCF WEB HTTP ヘルプページを有効にするには、サービスのエンドポイントにエンドポイント動作を追加する必要があります。これは、構成で追加することも、コードで追加することもできます。 WCF WEB HTTP ヘルプページを構成で有効化するには、<webHttp> 要素を持つエンドポイント動作を追加し、helpEnabled を true に設定し、エンドポイントを追加して、エンドポイント動作を使用するようにそれを構成します。次の構成コードは、この実行方法を示しています。

<endpointBehaviors>  
   <behavior name="RESTEndpointBehavior">  
      <webHttp helpEnabled="true"/>  
   </behavior>  
</endpointBehaviors>  
<!-- ... -->  
<services>  
   <service behaviorConfiguration="RESTWebServiceBehavior" name="RESTWebService">      <endpoint address="" kind="webHttpEndpoint" behaviorConfiguration="RESTEndpointBehavior" contract="IHello" />  
  
      <!-- ... -->  
   </service>  
</services>

WCF Web HTTP ヘルプページをコードで有効化するには、サービスエンドポイントを追加し、WebHttpBehavior をエンドポイントに追加し、HelpEnabled を true に設定します。この方法を次のコードに示します。

using (WebServiceHost host = new WebServiceHost(typeof(Service), new Uri("http://localhost:8000/Customers")))  
{  
   host.AddServiceEndpoint(typeof(ICustomerCollection), new WebHttpBinding(), "");
   host.Description.Endpoints[0].Behaviors.Add(new WebHttpBehavior { EnableHelp = true });  
   // ...  
}

ヘルプページは XHTML ベースで、ページの各部分を識別するマークアップがあります。これにより、クライアントは、XElement またはその他の XLinq API を使用して、ページにプログラムでアクセスできます。