web

Documentation

Index

• func Run(gnps GNParserService)
• type Data
  • func NewData() *Data
• type GNParserService
  • func NewGNParserService(gnp gnparser.GNParser, port int) GNParserService

Functions

func Run

func Run(gnps GNParserService)

Run starts the GNParser web service and servies both RESTful API and a website.

Types

type Data

type Data struct {
	Input    string
	Parsed   []string
	HomePage bool
	Version  string
}

Data contains information required to render web-pages.

func NewData

func NewData() *Data

NewData creates new Data for web-page templates.

type GNParserService

type GNParserService interface {
	gnparser.GNParser
	// Ping is a method to check if the service is running. Returns "pong".
	Ping() string
	// Port returns the port of the service.
	Port() int
}

GNParserService is an interface that provides functionality for GNParser RESTful service.

func NewGNParserService

func NewGNParserService(gnp gnparser.GNParser, port int) GNParserService

NewGNParserService creates a new object that implements GNParserService interface.