生成WCF REST服务的示例数据?

时间:2012-06-05 20:55:52

标签: c# xml json wcf rest

是否有某种方法可以基于WCF REST接口生成示例XML / JSON?大多数情况下,使用我们的Web服务的设备会将消息反序列化为相关对象。但有时候这是不可能的,因此我需要向开发人员发送他们需要提供给服务的实际XML / JSON以及输出的样子。是否有一种简单的方法来生成此信息,即使它使用数据类型的默认值?

Web服务接口的示例:

    [OperationContract]
    [WebGet(UriTemplate = "Test", ResponseFormat = WebMessageFormat.Xml)]
    ResultOfAction Test();

    // used to login
    [OperationContract]
    [WebInvoke(UriTemplate = "Login?", Method = "POST", ResponseFormat = WebMessageFormat.Xml, RequestFormat = WebMessageFormat.Xml, BodyStyle = WebMessageBodyStyle.Bare)]
    ResultOfAction Login(LoginRequest request);

    // register a client + forgot password
    [OperationContract]
    [WebInvoke(UriTemplate = "RequestOTP?", Method = "POST", ResponseFormat = WebMessageFormat.Xml, RequestFormat = WebMessageFormat.Xml, BodyStyle = WebMessageBodyStyle.Bare)]
    ResultOfAction RequestOTP(RequestOneTimePIN requestOneTimePin);

在上面的示例中,我需要查看ResultOfAction,LoginRequest和RequestOneTimePIN序列化XML。有没有一种简单的方法来生成这样的信息?

1 个答案:

答案 0 :(得分:4)

在配置中设置helpEnabled="true"属性时,WCF 4.0将根据您从服务方法调用返回的格式生成示例数据:

<behaviors>  
    <endpointBehaviors>
        <behavior name="webHttpBehavior">
            <webHttp helpEnabled="true"/>
        </behavior>
    </endpointBehaviors> 
</behaviors>

这是来自MSDN的example