api

Documentation

Index

• type API
  • func Setup(ctx context.Context, cfg *config.Config, r *mux.Router, areaStore AreaStore, ...) (*API, error)
• type AreaStore

Types

type API

type API struct {
	Router *mux.Router

	GeoData map[string]models.AreasDataResults
	// contains filtered or unexported fields
}

API provides a struct to wrap the api around

func Setup

func Setup(ctx context.Context, cfg *config.Config, r *mux.Router, areaStore AreaStore, rdsConn *pgx.PGX) (*API, error)

Setup function sets up the api and returns an api

type AreaStore

type AreaStore interface {
	Close(ctx context.Context) error
	Checker(context.Context, *healthcheck.CheckState) error
	GetArea(ctx context.Context, id string) (*models.Area, error)
	GetVersion(ctx context.Context, id string, versionID int) (*models.Area, error)
	GetAreas(ctx context.Context, offset, limit int) (*models.AreasResults, error)
}

AreaStore represents all the required methods from mongo DB