api

package

v0.0.0-...-90a23b5 Latest Latest Go to latest Published: Mar 28, 2023 License: MIT Imports: 14 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/dmartzol/goapi

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type Account
- func ToAPIAccount(internalAccount *goapi.Account, options map[string]bool) Account
- func Views(accs goapi.Accounts, options map[string]bool) []Account
type CreateAccountRequest
- func (c *CreateAccountRequest) Validate() error
type Handler
- func New(ac pb.AccountsClient, logger *zap.SugaredLogger, logRawRequest bool) (*Handler, error)

Constants ¶

View Source

const (
	CookieName = "goapi-Cookie"
)

Variables ¶

View Source

var (
	ErrExpiredSession error
)

Functions ¶

This section is empty.

Types ¶

type Account ¶

type Account struct {
	ID                         uuid.UUID `json:"ID"`
	FirstName, LastName, Email string
	Gender                     string
}

AccountView is the restricted response body of Account see: https://stackoverflow.com/questions/46427723/golang-elegant-way-to-omit-a-json-property-from-being-serialized

func ToAPIAccount ¶

func ToAPIAccount(internalAccount *goapi.Account, options map[string]bool) Account

ToAPIAccount returns the Account struct restricted to those fields allowed in options see: https://stackoverflow.com/questions/46427723/golang-elegant-way-to-omit-a-json-property-from-being-serialized

func Views ¶

func Views(accs goapi.Accounts, options map[string]bool) []Account

type CreateAccountRequest ¶

type CreateAccountRequest struct {
	FirstName string
	LastName  string
	Email     string
}

func (*CreateAccountRequest) Validate ¶

func (c *CreateAccountRequest) Validate() error

type Handler ¶

type Handler struct {
	*zap.SugaredLogger
	Accounts      pb.AccountsClient
	Router        *gin.Engine
	LogRawRequest bool
	// contains filtered or unexported fields
}

func New ¶

func New(ac pb.AccountsClient, logger *zap.SugaredLogger, logRawRequest bool) (*Handler, error)

func (*Handler) AuthMiddleware ¶

func (h *Handler) AuthMiddleware(c *gin.Context)

func (*Handler) InitializeRoutes ¶

func (h *Handler) InitializeRoutes()

func (*Handler) Unmarshal ¶

func (h *Handler) Unmarshal(c *gin.Context, iface interface{}) error

func (*Handler) WrappedLogger ¶

func (h *Handler) WrappedLogger(ctx context.Context) *zap.SugaredLogger

Source Files ¶

View all Source files

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