handlers

package

v0.0.0-...-b1bf2c7 Latest Latest Go to latest Published: Mar 25, 2023 License: Apache-2.0 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/shikharvashistha/krypto-alerts

Documentation ¶

Index ¶

Constants
func JWTAuthentication() func(*gin.Context) error
func NewEndpoint(app Application) *endpoint
func RegisterHTTPHandlers(e *gin.RouterGroup, app Application)
type Application
- func NewAppSvc(store store.Store, logger *utils.Logger) Application
type Token
- func JWTAuthenticationVerify(c *gin.Context) (*Token, error)

Constants ¶

View Source

const (
	CreateAlert = "/create/alert"     //CreateAlert path for creating an alert
	GetAlerts   = "/get/alerts"       //GetAlerts path for getting all the alerts
	DeleteAlert = "/delete/alert/:id" //DeleteAlert path for deleting an alert
	GetToken    = "/get/token"        //GetToken path for getting a JWT token
)

Variables ¶

This section is empty.

Functions ¶

func JWTAuthentication ¶

func JWTAuthentication() func(*gin.Context) error

This is the middleware function that will be used to protect routes with JWT authentication

func NewEndpoint ¶

func NewEndpoint(app Application) *endpoint

func RegisterHTTPHandlers ¶

func RegisterHTTPHandlers(e *gin.RouterGroup, app Application)

Types ¶

type Application ¶

type Application interface {
	CreateAlert(c *gin.Context) // CreateAlert implements Application to create an alert
	GetAlerts(c *gin.Context)   // GetAlerts implements Application to get all the alerts
	DeleteAlert(c *gin.Context) // DeleteAlert implements Application to delete an alert
	GetToken(c *gin.Context)    // GetToken implements Application to get a JWT token
}

func NewAppSvc ¶

func NewAppSvc(store store.Store, logger *utils.Logger) Application

type Token ¶

type Token struct {
	ID      string  `json:"id"`
	Expires float64 `json:"expires"`
}

func JWTAuthenticationVerify ¶

func JWTAuthenticationVerify(c *gin.Context) (*Token, error)

This is the middleware function that will be used to verify if the current JWT token is valid or nott

Source Files ¶

View all Source files

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