api

package

v0.0.0-...-c528fcf Latest Latest Go to latest Published: Mar 11, 2024 License: MIT Imports: 13 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/pejeio/blood-donate-locator-api

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func CorsHandler() fiber.Handler
func CreateLocationAuthzMiddleware(authClient *auth.Client) fiber.Handler
func DeleteLocationAuthzMiddleware(authClient *auth.Client) fiber.Handler
func ForbiddenJSONErrorResponse(c *fiber.Ctx) error
func GetBearerTokenFromHeaders(c *fiber.Ctx) string
func GetUserIDFromCtx(c *fiber.Ctx) string
func Protect(authClient *auth.Client) fiber.Handler
func SetUserIDOnCtx(c *fiber.Ctx, value string)
func UnauthorizedJSONErrorResponse(c *fiber.Ctx) error
type ErrorResponse
- func ValidateStruct(s interface{}) []*ErrorResponse
type JSONErrorResponse
type PageLimitOffset
- func GetPaginationQueryParams(c *fiber.Ctx) (*PageLimitOffset, error)
type Server
- func NewServer(ctx context.Context, c *configs.Config, s store.Store, authC *auth.Client, ...) *Server

Constants ¶

View Source

const (
	DefaultLimit  = 10
	DefaultOffset = 0
)

Variables ¶

This section is empty.

Functions ¶

func CorsHandler ¶

func CorsHandler() fiber.Handler

func CreateLocationAuthzMiddleware ¶

func CreateLocationAuthzMiddleware(authClient *auth.Client) fiber.Handler

Check if the user has rights to create a location

func DeleteLocationAuthzMiddleware ¶

func DeleteLocationAuthzMiddleware(authClient *auth.Client) fiber.Handler

Check if the user has rights to delete a location

func ForbiddenJSONErrorResponse ¶

func ForbiddenJSONErrorResponse(c *fiber.Ctx) error

func GetBearerTokenFromHeaders ¶

func GetBearerTokenFromHeaders(c *fiber.Ctx) string

GetBearerTokenFromHeaders retrieves the bearer token from the headers of a fiber.Ctx object.

func GetUserIDFromCtx ¶

func GetUserIDFromCtx(c *fiber.Ctx) string

func Protect ¶

func Protect(authClient *auth.Client) fiber.Handler

Just a general middleware that checks for a valid JWT token

func SetUserIDOnCtx ¶

func SetUserIDOnCtx(c *fiber.Ctx, value string)

func UnauthorizedJSONErrorResponse ¶

func UnauthorizedJSONErrorResponse(c *fiber.Ctx) error

Types ¶

type ErrorResponse ¶

type ErrorResponse struct {
	Field string `json:"failed_field"`
	Tag   string `json:"tag"`
}

func ValidateStruct ¶

func ValidateStruct(s interface{}) []*ErrorResponse

type JSONErrorResponse ¶

type JSONErrorResponse struct {
	Message string `json:"message"`
}

type PageLimitOffset ¶

type PageLimitOffset struct {
	Limit  int
	Offset int
}

func GetPaginationQueryParams ¶

func GetPaginationQueryParams(c *fiber.Ctx) (*PageLimitOffset, error)

type Server ¶

type Server struct {
	Ctx        context.Context
	App        *fiber.App
	Config     *configs.Config
	AuthClient *auth.Client
	Store      store.Store
}

func NewServer ¶

func NewServer(ctx context.Context, c *configs.Config, s store.Store, authC *auth.Client, app *fiber.App) *Server

func (*Server) Cors ¶

func (s *Server) Cors()

func (*Server) CreateLocation ¶

func (s *Server) CreateLocation(c *fiber.Ctx) error

func (*Server) DeleteLocation ¶

func (s *Server) DeleteLocation(c *fiber.Ctx) error

DeleteLocation deletes a location.

func (*Server) FindLocation ¶

func (s *Server) FindLocation(c *fiber.Ctx) error

FindLocation finds the location based on the provided ID.

func (*Server) FindLocations ¶

func (s *Server) FindLocations(c *fiber.Ctx) error

FindLocations retrieves a list of locations based on the provided query parameters.

func (*Server) FindLocationsByCoordinates ¶

func (s *Server) FindLocationsByCoordinates(c *fiber.Ctx) error

FindLocationsByCoordinates finds locations by coordinates.

func (*Server) Routes ¶

func (s *Server) Routes()

func (*Server) Start ¶

func (s *Server) Start()

Source Files ¶

View all Source files

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