web

Documentation

Overview

Package web provides RESTful API service and a website for gnparser.

Index

• func NewTemplate() (*echoTempl, error)
• func Run(gnps GNparserService)
• type Data
• type GNparserService
  • func NewGNparserService(gnp gnparser.GNparser, port int) GNparserService

Functions

func NewTemplate

func NewTemplate() (*echoTempl, error)

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            []parsed.Parsed
	Format            string
	HomePage          bool
	Version           string
	WithDetails       bool
	WithCultivars     bool
	PreserveDiaereses bool
}

Data contains information required to render web-pages.

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.