rest

Documentation

Overview

package rest provides http REST interface to gnmatcher functionality.

Index

• func Run(m MatcherService)
• type MatcherService
  • func NewMatcherService(gnm gnmatcher.GNmatcher, port int, enc gnfmt.Encoder) MatcherService

Functions

func Run

func Run(m MatcherService)

Run creates and runs a RESTful API service of gnmatcher. this API is described by OpenAPI schema at https://apidoc.gnames.org/gnmatcher

Types

type MatcherService

type MatcherService interface {
	// Port returns the port of the service.
	Port() int

	// Ping checks connection to the service.
	Ping() string

	// GNmatcher is the main use-case of the gnmatcher project.
	gnmatcher.GNmatcher

	// Encoder provides serialization/deserialization interface.
	gnfmt.Encoder
}

MatcherService describes remote service of gnmatchter.

func NewMatcherService

func NewMatcherService(gnm gnmatcher.GNmatcher,
	port int, enc gnfmt.Encoder) MatcherService

NewMNewMatcherREST is a constructor for MatchREST.