api

Documentation

Overview

Package api implements the client-side API for code wishing to interact with the code-odessey service. The methods of the Server type correspond to the code-odessey REST API.

Examples

Several examples of using this package are available in the GitHub repository.

Index

• type Server
  • func NewServer(config config.Config, store db.Store) (*Server, error)
  • func (server *Server) Start(address string) error

Types

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server encapsulates the db, Engine, config to help connect to db and its related functions Engine helps send api request to correct handler for processing

func NewServer

func NewServer(config config.Config, store db.Store) (*Server, error)

create a new server instance

func (*Server) Start

func (server *Server) Start(address string) error

Start runs the HTTP server on a specific address.