Working with Service Fabric stateless WebAPI services

Search…
Most of the time you can use most of your generated templates and just define your custom controller class and the methods defined will work as expected.
Note: Also define the objects that are used for the request and the response. I usually put these in a separate project called <ServiceName>.Models.
But if you want to ensure that your response does exactly what you want. (ie return a different HTTP status code), you can overload with the following approach.
Here is a standard controller class:
1
namespace HealthCheck.Controllers
2
{
3
    [ServiceRequestActionFilter]
4
    public class HealthCheckController : ApiController
5
    {
6
        // GET api/HealthCheck 
7
        public HealthCheckGetResponse Get()
8
        {
9
            ServiceEventSource.Current.Message("Health Check GET called");
10
            return new HealthCheckGetResponse() {Result = "Success"};
11
        }
12
​
13
        // POST api/HealthCheck 
14
        public HealthCheckPostResponse Post([FromBody]HealthCheckPost value)
15
        {
16
            ServiceEventSource.Current.Message("Health Check POST called with Mode of: {0}", value?.Mode);
17
​
18
            // TODO perform an action to store the Value of Mode somewhere.
19
​
20
            return new HealthCheckPostResponse() { Result = "Success" };
21
        }
22
​
23
        public HttpResponseMessage Post([FromBody]HealthCheckPost value)
24
        {
25
            ServiceEventSource.Current.Message("Health Check POST called with Mode of: {0}", value?.Mode);
26
​
27
            // TODO perform an action to store the Value of Mode somewhere.
28
​
29
            var resp =  new HealthCheckPostResponse() { Result = "Success" };
30
            return Request.CreateResponse(HttpStatusCode.OK, resp, Configuration.Formatters.XmlFormatter);
31
        }
32
    }
33
}
Copied!
If you wanted the response to be XML (instead of the default JSON and the HTTP Status code to be something different you could re-write the post method from:
1
// POST api/HealthCheck 
2
public HealthCheckPostResponse Post([FromBody]HealthCheckPost value)
3
{
4
    ServiceEventSource.Current.Message("Health Check POST called with Mode of: {0}", value?.Mode);
5
​
6
    // TODO perform an action to store the Value of Mode somewhere.
7
​
8
    return new HealthCheckPostResponse() { Result = "Success" };
9
}
Copied!
to
1
public HttpResponseMessage Post([FromBody]HealthCheckPost value)
2
{
3
    ServiceEventSource.Current.Message("Health Check POST called with Mode of: {0}", value?.Mode);
4
​
5
    // TODO perform an action to store the Value of Mode somewhere.
6
​
7
    var resp =  new HealthCheckPostResponse() { Result = "Success" };
8
    return Request.CreateResponse(HttpStatusCode.OK, resp, Configuration.Formatters.XmlFormatter);
9
}
Copied!
How to create a single node cluster (offline)
How to configure HTTPS endpoints in WebAPI services
Last modified 2yr ago
Copy link