Documentation
Content
Frameworks
Controllers

Controllers

GenHTTP.Modules.Controllers

This framework allows to create APIs by defining and implementing controller classes. In contrast to ASP.NET you cannot use this framework to dynamically render HTML pages in a MVC style project, so this is just another flavor of defining a web API.

ℹī¸
Controller based APIs can quickly be created by using a project template.

Hosting an API

The following example shows how an API controlling an IoT device could look like when implemented using the controller framework.

The methods of the controller class will automatically be translated into paths that can be called by the client.

// API will be available via http://localhost:8080/device/

var api = Layout.Create()
                .AddController<IotController>("device")
                .Add(CorsPolicy.Permissive());
                
await Host.Create()
          .Handler(api)
          .Defaults()
          .Development()
          .Console()
          .RunAsync();
    
// --

public class IotController
{

    public DeviceInfo Index() 
    {
        // GET http://localhost:8080/device/
    }
    
    public DeviceFieldInfo Field([FromPath] int fieldID) 
    {
        // GET http://localhost:8080/device/field/4711
    }
    
    [ControllerAction(RequestMethod.POST)]
    public DeviceInfo Restart() 
    {
        // POST http://localhost:8080/device/restart
    }

}

URL Patterns

The following table shows the rules that are applied to map an URL:

Method Endpoint
Index() /controller/
Action() /controller/action/
Action([FromPath] int id) /controller/action/:id/
Action(int id) /controller/action/?id=:id
LongAction() /controller/long-action/

Further Resources

The following capabilities are shared by various application frameworks:

Method Definitions

Share
Functional HandlersStatic Websites