api

Documentation

Overview

Package api provides the api for the explorer service.

Index

• Constants
• func InitDB(ctx context.Context, address string, readOnly bool) (db.ConsumerDB, error)
• func Start(ctx context.Context, cfg Config) error
• type Config

Constants

const HealthCheck string = "/health-check"

HealthCheck is the health check endpoint.

Functions

func InitDB

func InitDB(ctx context.Context, address string, readOnly bool) (db.ConsumerDB, error)

InitDB initializes a database given a database type and path.

func Start

func Start(ctx context.Context, cfg Config) error

Start starts the api server.

Types

type Config

type Config struct {
	// HTTPPort is the http port for the api
	HTTPPort uint16
	// Address is the address of the database
	Address string
	// ScribeURL is the url of the scribe service
	ScribeURL string
}

Config contains the config for the api.