api

package

v0.0.0-...-919b350 Latest Latest Go to latest Published: Aug 24, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bokan/facedetection

Links

Open Source Insights

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL