api

Documentation

Index

• type API
  • func NewAPI(addr string, d download.Downloader, fd facedetect.FaceDetector) *API
  • func (a *API) Routes() http.Handler
  • func (a *API) Serve(ctx context.Context, handler http.Handler) error
• type Error
• type Faces

Types

type API

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

API handles Face Detect requests, register routes and creates the HTTP server.

func NewAPI

func NewAPI(addr string, d download.Downloader, fd facedetect.FaceDetector) *API

NewAPI creates a HTTP API responsible for serving face detection requests. Call Serve afterwards and pass a parent context and the return value of Routes as parameters.

func (*API) Routes

func (a *API) Routes() http.Handler

Routes returns a http.Handler with routes configured.

func (*API) Serve

func (a *API) Serve(ctx context.Context, handler http.Handler) error

Serve starts a HTTP server and serves provided handler. To invoke face detection endpoint, perform a GET request on /v1/face-detect?={image_url}.

type Error

type Error struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

Error is reserved for future use.

type Faces

type Faces struct {
	Faces []facedetect.Face `json:"Faces"`
}

Faces structure is response sent to client. It encapsulates response from face detector.