api

Documentation

Index

• type API
  • func NewAPI() (*API, error)
  • func (api *API) StartServing(port int64) error

Types

type API

type API struct {
	Router *gin.Engine `json:"router"` // The HTTP router

	DB *bolt.DB `json:"db"` // The database

	CWD    *core.ChromeWebDriver `json:"cwd"` // The web driver / scraper
	Engine engine.Engine         // The scraping engine

	Root string `json:"root"` // API root route

	Logger *loggo.Logger `json:"logger"` // The logger

	Client *http.Client `json:"client"` // The HTTP client
}

API represents an API instance.

func NewAPI

func NewAPI() (*API, error)

NewAPI initializes a new API instance.

func (*API) StartServing

func (api *API) StartServing(port int64) error

StartServing starts serving the API.