REST Handler

Link to code: Adding a REST API to your Plugin

In this tutorial we will learn how to add a REST API to your plugin. The Ligato infrastructure provides an HTTP server that is used by all plugins that wish to expose a REST API to external clients. The HTTP Server is provided by the REST plugin.


Each plugin requiring a REST APPI will register its own custom handler with the REST plugin using the registration API:

type HandlerProvider func(formatter *render.Render) http.HandlerFunc

type HTTPHandlers interface {
    RegisterHTTPHandler(path string, provider HandlerProvider, methods ...string) *mux.Route
    // ...

To use the REST plugin, we first define it as a dependency in our plugin:

type MyPlugin struct {
    REST rest.HTTPHandlers

Note that the dependency is defined as an interface. This means it can be satisfied by any object that implements the interface methods. The rest.HTTPHandlers interface is defined in cn-infra/rpc/rest/plugin_api_rest.go.

Next, we can “wire” the dependency (i.e. set the instance) in the plugin’s constructor. Note that we use the default REST plugin provided by the Ligato infrastructure (rest.DefaultPlugin). Most Ligato infrastructure plugins have a default plugin instance defined as a global variable that can be used.

func NewMyPlugin() *MyPlugin {
    // ...
    p.REST = &rest.DefaultPlugin
    return p

Now we define our handler:

func (p *MyPlugin) fooHandler(formatter *render.Render) http.HandlerFunc {
    return func(w http.ResponseWriter, r *http.Request) {
        body, err := ioutil.ReadAll(r.Body)
        if err != nil {
            p.Log.Errorf("Error reading body: %v", err)
            http.Error(w, "can't read body", http.StatusBadRequest)
        formatter.Text(w, http.StatusOK, fmt.Sprintf("Hello %s", body))

Finally, we register our handler with the REST plugin. This is done in our plugin’s Init method:

func (p *MyPlugin) Init() error {
    // ...
    p.REST.RegisterHTTPHandler("/greeting", p.fooHandler, "POST")
    return nil

Now we run the app and try using curl:

curl -X POST -d 'John' -H "Content-Type: application/json" http://localhost:9191/greeting
// outputs: Hello John

Complete working example can be found at examples/tutorials/03_rest-handler.