restapi

Documentation

Index

• Constants
• type App
  • func New(commonApp *commonApp.App, cfg config.Configuration) *App
  • func (app *App) RegisterHandlers()
  • func (app *App) Run() error
• type Controller

Constants

const Version = "1.0.0"

Version of API

Types

type App

type App struct {
	*commonApp.App
	Server *http.Server
	// contains filtered or unexported fields
}

App is the application for API

func New

func New(commonApp *commonApp.App, cfg config.Configuration) *App

New func is a constructor for the ApiApp

func (*App) RegisterHandlers

func (app *App) RegisterHandlers()

RegisterHandlers sets up the routing of the HTTP handlers.

func (*App) Run

func (app *App) Run() error

Run is func to run the ApiApp

type Controller

type Controller interface {
	RegisterHandlers()
}