WCF – How to Host a custom WCF service in SharePoint

Recently I had to write a Custom WCF Service in SharePoint 2013 to expose the employee related data. You may be surprised to see how quickly it can be done on SharePoint, these are the basic steps you need to follow to get it working.

Step#1
Create an Empty SharePoint 2013 Solution

Step#2
Enter the URL of a Site Collection and select Farm Solution

Step#3
Add the following References on the Add Reference

Step#4
Create the Required Domain Objects

1 2 3 4 5 6 7 8 9 10 11 12 13

namespace EmployeeDirectory.Domain {     [DataContract]     class Employee     {         [DataMember]         public string ID { get; set; }         [DataMember]         public string FirstName { get; set; }         [DataMember]         public string LastName { get; set; }     } }

Step#5
Create the Required Service Interface

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26

namespace EmployeeDirectory.Service {     [ServiceContract]     interface IEmployeeData     {         [OperationContract]         [WebInvoke(Method = "POST", UriTemplate = "/add", RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)]         Employee Add(Employee employee);         [OperationContract]         [WebGet(ResponseFormat = WebMessageFormat.Json, UriTemplate = "/get")]         List<Employee> GetAllEmployees();         [OperationContract]         [WebGet(UriTemplate = "/get/{id}", RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)]         Employee Get(string id);         [OperationContract]         [WebInvoke(Method = "PUT", UriTemplate = "/update", RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)]         Employee Update(Employee employee);         [OperationContract]         [WebInvoke(Method = "DELETE", UriTemplate = "/delete/{id}", RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)]         void Delete(string id);     } }

Step#6
Create the Required Service Class

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

namespace EmployeeDirectory.Service {     [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]     class EmployeeData : IEmployeeData     {         public List<Employee> GetAllEmployees()         {             List<Employee> allEmployees = new List<Employee>();             allEmployees.Add(new Employee() { ID = "1", FirstName = "Karthik", LastName = "Vijay" });             return allEmployees;         }         public Employee Add(Employee employee)         {             List<Employee> allEmployees = new List<Employee>();             allEmployees.Add(employee);             return employee;         }         public Employee Get(string id)         {             List<Employee> allEmployees = new List<Employee>();             allEmployees.Add(new Employee() { ID = "1", FirstName = "Karthik", LastName = "Vijay" });             return allEmployees.First(employee => employee.ID == id);         }         public Employee Update(Employee employee)         {             List<Employee> allEmployees = new List<Employee>();             allEmployees.Add(new Employee() { ID = "1", FirstName = "Karthik", LastName = "Vijay" });             Employee emp = allEmployees.First(e => e.ID == employee.ID);             emp.FirstName = employee.FirstName;             emp.LastName = employee.LastName;             return emp;         }         public void Delete(string id)         {             List<Employee> allEmployees = new List<Employee>();             allEmployees.Add(new Employee() { ID = "1", FirstName = "Karthik", LastName = "Vijay" });             allEmployees.Remove(allEmployees.First(employee => employee.ID == id));         }     } }

Step#7
Add Layouts folder to the solution

Step#8
Since we cannot add a svc file directly, add a text file and rename it to .SVC

Step#9
Prepare the .Svc

1 2 3 4 5 6

<%@ ServiceHost     Debug="true"     Language="C#"     Service="EmployeeDirectory.Service.EmployeeData"     Factory="Microsoft.SharePoint.Client.Services.MultipleBaseAddressWebServiceHostFactory, Microsoft.SharePoint.Client.ServerRuntime, Version=14.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>

Step#10
Select the Project and go to Properties. Modify the Deployment Target Property as WebApplication

Step#11
Deploy the solution and test from the Browser by giving the following url

For more reference