endpoint

Documentation

Overview

THIS FILE IS AUTO GENERATED BY GK-CLI DO NOT EDIT!!

Index

• func InstrumentingMiddleware(duration metrics.Histogram) endpoint.Middleware
• func LoggingMiddleware(logger log.Logger) endpoint.Middleware
• func MakeCreateEndpoint(s service.UsersService) endpoint.Endpoint
• func MakeRetrieveEndpoint(s service.UsersService) endpoint.Endpoint
• type CreateRequest
• type CreateResponse
  • func (r CreateResponse) Failed() error
• type Endpoints
  • func New(s service.UsersService, mdw map[string][]endpoint.Middleware) Endpoints
  • func (e Endpoints) Create(ctx context.Context, email string, password string) (e0 error)
  • func (e Endpoints) Retrieve(ctx context.Context, email string) (e0 error)
• type Failure
• type RetrieveRequest
• type RetrieveResponse
  • func (r RetrieveResponse) Failed() error

Functions

func InstrumentingMiddleware

func InstrumentingMiddleware(duration metrics.Histogram) endpoint.Middleware

InstrumentingMiddleware returns an endpoint middleware that records the duration of each invocation to the passed histogram. The middleware adds a single field: "success", which is "true" if no error is returned, and "false" otherwise.

func LoggingMiddleware

func LoggingMiddleware(logger log.Logger) endpoint.Middleware

LoggingMiddleware returns an endpoint middleware that logs the duration of each invocation, and the resulting error, if any.

func MakeCreateEndpoint

func MakeCreateEndpoint(s service.UsersService) endpoint.Endpoint

MakeCreateEndpoint returns an endpoint that invokes Create on the service.

func MakeRetrieveEndpoint

func MakeRetrieveEndpoint(s service.UsersService) endpoint.Endpoint

MakeRetrieveEndpoint returns an endpoint that invokes Retrieve on the service.

Types

type CreateRequest

type CreateRequest struct {
	Email    string `json:"email"`
	Password string `json:"password"`
}

CreateRequest collects the request parameters for the Create method.

type CreateResponse

type CreateResponse struct {
	E0 error `json:"e0"`
}

CreateResponse collects the response parameters for the Create method.

func (CreateResponse) Failed

func (r CreateResponse) Failed() error

Failed implements Failer.

type Endpoints

type Endpoints struct {
	CreateEndpoint   endpoint.Endpoint
	RetrieveEndpoint endpoint.Endpoint
}

Endpoints collects all of the endpoints that compose a profile service. It's meant to be used as a helper struct, to collect all of the endpoints into a single parameter.

func New

func New(s service.UsersService, mdw map[string][]endpoint.Middleware) Endpoints

New returns a Endpoints struct that wraps the provided service, and wires in all of the expected endpoint middlewares

func (Endpoints) Create

func (e Endpoints) Create(ctx context.Context, email string, password string) (e0 error)

Create implements Service. Primarily useful in a client.

func (Endpoints) Retrieve

func (e Endpoints) Retrieve(ctx context.Context, email string) (e0 error)

Retrieve implements Service. Primarily useful in a client.

type Failure

type Failure interface {
	Failed() error
}

Failure is an interface that should be implemented by response types. Response encoders can check if responses are Failer, and if so they've failed, and if so encode them using a separate write path based on the error.

type RetrieveRequest

type RetrieveRequest struct {
	Email string `json:"email"`
}

RetrieveRequest collects the request parameters for the Retrieve method.

type RetrieveResponse

type RetrieveResponse struct {
	E0 error `json:"e0"`
}

RetrieveResponse collects the response parameters for the Retrieve method.

func (RetrieveResponse) Failed

func (r RetrieveResponse) Failed() error

Failed implements Failer.