Using guidelines from:

https://github.com/tfredrich/RestApiTutorial.com

When the raspberry pi 2 was released, all windows 10 users were filled with joy when Microsoft announced the support of windows 10 for this neat device. After a couple of beta builds, we got the RTM version a couple of weeks ago. A crucial piece for this platform is missing, WCF. It might be supported in the future (see post), but untill then I would need some simple REST implementation to keep my projects going. I decided to implement a simple HTTP REST service.

All functionality is presented in a sample controller, which can be found in the WebServerHostTest project.

We're all coders, so I'll explain in a way a coder understands best... sample code :)

using Devkoes.Restup.WebServer;

private async Task InitializeWebServer()
{
    RestWebServer webserver = new RestWebServer(80); //defaults to 8800
    webserver.RegisterController<ParametersController>();

    await webserver.StartServerAsync();
}

[RestController(InstanceCreationType.Singleton)]
public class ParametersController
{
  [UriFormat("/parameters/{parameterId}")] 
  public PostResponse CreateUser(int parameterId, [FromBody] string parameterValue) 
  {
    return new PostResponse(PostResponse.ResponseStatus.Created, $"/users/{userId}"); 
  }
}

You can choose to have one instance of your rest controller for the whole application cycle, or one per call. This is controller by the RestController class attribute.

[RestController(InstanceCreationType.Singleton)]
[RestController(InstanceCreationType.PerCall)]

The return type of your method is used to determine the verb of the REST request it will respond to. There are four (duh!) available verb types:

• GetResponse (get)
• PostResponse (create)
• PutResponse (update)
• DeleteResponse (delete)

You can use the UriFormatAttribute on your method to define the uri you want to match on. All strings between { and } will be handled as input parameter and should have a corresponding method parameter.

You can use the FromBodyAttribute on a method parameter. Restup will deserialize the http body and use that as value for the parameter.

Note: there can only be one FromBodyAttribute per method and it should always be the last parameter.

All public methods in the controller which have the UriFormatAttribute and one of the verb responses as return type will be indexed as REST method.

There are two content types supported: xml and json. The .NET internal xml serializer is used for XML. For Json I've used the incredible lib from Newtonsoft. By default all your types are serializable by both serializers. Just createa class/struct with properties and it will be serialized correctly.

If your http request has a body, the "Content-Type" header is used to determine the serializer.

If your controller method returns a GetResponse, the http request header "Accept" is used to determine the serializer.

Note: all serializers default to Json if headers are missing.