api

Documentation

Overview

Package api defines the API V1 implementation for tenant-api.

Index

• Constants
• Variables
• type PaginationParams
• type Router
  • func NewRouter(db *sql.DB, ps *pubsub.Client, options ...RouterOption) *Router
  • func (r *Router) DatabaseCheck(ctx context.Context) error
  • func (r *Router) Routes(e *echo.Group)
• type RouterOption
  • func WithLogger(logger *zap.Logger) RouterOption
  • func WithMiddleware(mdw ...echo.MiddlewareFunc) RouterOption

Constants

const (
	// TenantIDService is the GID service portion of the prefix.
	TenantIDService = "tnnt"

	// TenantIDResource is the GID resource portion of the prefix.
	TenantIDResource = "ten"

	// TenantIDPrefix is the full prefix for a Tenant GID.
	TenantIDPrefix = TenantIDService + TenantIDResource
)

Variables

var (
	// ErrInvalidID is returned when a ID is invalid
	ErrInvalidID = errors.New("invalid ID")

	// ErrIDNotFound is returned when a ID is not found in the path
	ErrIDNotFound = errors.New("ID not found in path")

	// ErrTenantNameMissing is returned when the Tenant Name is not defined.
	ErrTenantNameMissing = errors.New("tenant name is missing")
)

Types

type PaginationParams

type PaginationParams struct {
	Limit   int    `json:"limit,omitempty"`
	Page    int    `json:"page,omitempty"`
	Cursor  string `json:"cursor,omitempty"`
	Preload bool   `json:"preload,omitempty"`
	OrderBy string `json:"orderby,omitempty"`
}

PaginationParams allow you to paginate the results

type Router

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

Router provides a router for the API

func NewRouter

func NewRouter(db *sql.DB, ps *pubsub.Client, options ...RouterOption) *Router

NewRouter creates a new APIv1 router.

func (*Router) DatabaseCheck

func (r *Router) DatabaseCheck(ctx context.Context) error

DatabaseCheck ensure the database connection is established.

func (*Router) Routes

func (r *Router) Routes(e *echo.Group)

Routes will add the routes for this API version to a router group

type RouterOption

type RouterOption func(r *Router)

RouterOption defines the router option type.

func WithLogger

func WithLogger(logger *zap.Logger) RouterOption

WithLogger sets the logger for the service.

func WithMiddleware

func WithMiddleware(mdw ...echo.MiddlewareFunc) RouterOption

WithMiddleware includes the provided middleware with the api.