How to expose a JSON endpoint from a WCF-service

2021-05-07 06:01:24 阅读：246 来源： 互联网

标签：endpoint service FirstName LastName expose BirthYear JSON Anders 1900

Having seen the small footprint set by JSON – I’ve begun using it extensively for mobile device (WP7) communication. In particular the phone scenario makes it desirable to have an as small as possible data load to transfer between server and device. When using the JSON formatting, you can really minimize the load as documented here. Below is what is returned in JSON-format (compare that to the verbose OData or SOAP formatting!):

[{"BirthYear":1900,"FirstName":"Anders","LastName":"And"},{"BirthYear":1900,"FirstName":"Anders","LastName":"And"},{"BirthYear":1900,"FirstName":"Anders","LastName":"And"},{"BirthYear":1900,"FirstName":"Anders","LastName":"And"},{"BirthYear":1900,"FirstName":"Anders","LastName":"And"}]

How to do ?
To expose a WCF-implemented service with JSON support, you need to setup these artifacts:

Service Contract:
First define the contract for the service to expose.

namespace WebService1
{
    [ServiceContract(Namespace="http://someethingelse.com")]
    public interface IEmployeeService
    {
        [OperationContract]
        [WebInvoke(BodyStyle=WebMessageBodyStyle.Bare, ResponseFormat=WebMessageFormat.Json)]
        Employee[] GetAll_POST();

        [OperationContract]
        [WebGet(BodyStyle = WebMessageBodyStyle.Bare, ResponseFormat = WebMessageFormat.Json)]
        Employee[] GetAll_GET();
    }

    [DataContract(Namespace="http://somethingunique.com")]
    public class Employee
    {
        [DataMember]
        public int BirthYear { get; set; }
        [DataMember]
        public string FirstName { get; set; }
        [DataMember]
        public string LastName { get; set; }
    }
}

Note the WebInvoke and WebGet attributes on the service definition. The WebInvoke attribute specifies that the method will obey POST-requests, where as the WebGetattribute will make the method obey GET-requests.

The two attributes takes parameters that allows for specifying in which format the data should be formatted. When the ResponseFormat=WebMessageFormat.Json is set, the data returned by the method is formatted as a clean and simple JSON notation.

Web.config
Of-course you also need to setup configuration in the web.config. Here you should pay special attention to the binding and the behaviorConfiguration attributes.
Important: In particular the endpointBehavior should have <webHttp> set as content to gain the clean JSON formatting (see below).

  <system.serviceModel>
    <services>
      <service name="WebService1.EmployeeService">
        <endpoint name="jsonEP"
                  address=""
                  binding="webHttpBinding"
                  behaviorConfiguration="json"
                  contract="WebService1.IEmployeeService"/>
      </service>
    </services>
    <behaviors>
      <endpointBehaviors>
        <behavior name="json">
          <webHttp/>
        </behavior>
      </endpointBehaviors>
    </behaviors>
  </system.serviceModel>

Client:
When calling the above service, you will receive a nicely formatted JSON string like this:

That’s how easy it is setting up when using WCF.

http://blog.clauskonrad.net/2010/11/how-to-expose-json-endpoint-from-wcf.html

标签：endpoint,service,FirstName,LastName,expose,BirthYear,JSON,Anders,1900
来源： https://www.cnblogs.com/wzihan/p/14737572.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

How to expose a JSON endpoint from a WCF-service