api

Documentation

Index

• func ResponseFailed(ctx *gin.Context, resp HTTPResponse, err error)
• func ResponseSuccess(ctx *gin.Context, resp HTTPResponse)
• type CreateProviderReq
• type HTTPResponse
  • func FailedCreateEntity(entityName string) HTTPResponse
  • func FailedDeleteEntity(entityName string) HTTPResponse
  • func FailedEmptyPayload() HTTPResponse
  • func FailedEntityConflict(entityName, fieldName, fieldValue string) HTTPResponse
  • func FailedEntityNotFound(entityName, fieldName, fieldValue string) HTTPResponse
  • func FailedGetEntity(entityName string) HTTPResponse
  • func FailedInvalidBody() HTTPResponse
  • func FailedInvalidParam(param string) HTTPResponse
  • func FailedInvalidQuery(query string) HTTPResponse
  • func FailedMissingParam(param string) HTTPResponse
  • func FailedMissingQuery(query string) HTTPResponse
  • func FailedUpdateEntity(entityName string) HTTPResponse
  • func SuccessCreateEntity(entityName string, data interface{}) HTTPResponse
  • func SuccessDeleteEntity(entityName string, data interface{}) HTTPResponse
  • func SuccessGetEntity(entityName string, data interface{}) HTTPResponse
  • func SuccessUpdateEntity(entityName string, data interface{}) HTTPResponse
• type PokemonHTTPHandler
  • func NewPokemonHTTPHandler(service domain.PokemonService) *PokemonHTTPHandler
  • func (h *PokemonHTTPHandler) GetPokemonByName(ctx *gin.Context)
• type ProviderHTTPHandler
  • func NewProviderHTTPHandler(service domain.ProviderService) *ProviderHTTPHandler
  • func (h *ProviderHTTPHandler) CreateProvider(ctx *gin.Context)
  • func (h *ProviderHTTPHandler) DeleteProviderByUUID(ctx *gin.Context)
  • func (h *ProviderHTTPHandler) GetProviderByUUID(ctx *gin.Context)
  • func (h *ProviderHTTPHandler) GetProviders(ctx *gin.Context)
  • func (h *ProviderHTTPHandler) UpdateProvider(ctx *gin.Context)
• type UpdateProviderReq

Functions

func ResponseFailed

func ResponseFailed(ctx *gin.Context, resp HTTPResponse, err error)

ResponseFailed proccess an HTTP response for failed request.

func ResponseSuccess

func ResponseSuccess(ctx *gin.Context, resp HTTPResponse)

ResponseSuccess proccess an HTTP response for successful request.

Types

type CreateProviderReq

type CreateProviderReq struct {
	ShortName string `json:"shortName" binding:"required"`
	LongName  string `json:"longName" binding:"required"`
}

CreateProviderReq represents JSON request for creating new provider.

type HTTPResponse

type HTTPResponse struct {
	Status  string      `json:"status"`
	Code    int         `json:"code"`
	Message string      `json:"message"`
	Data    interface{} `json:"data"`
}

HTTPResponse represents JSON response for HTTP handler.

func FailedCreateEntity

func FailedCreateEntity(entityName string) HTTPResponse

func FailedDeleteEntity

func FailedDeleteEntity(entityName string) HTTPResponse

func FailedEmptyPayload

func FailedEmptyPayload() HTTPResponse

func FailedEntityConflict

func FailedEntityConflict(entityName, fieldName, fieldValue string) HTTPResponse

func FailedEntityNotFound

func FailedEntityNotFound(entityName, fieldName, fieldValue string) HTTPResponse

func FailedGetEntity

func FailedGetEntity(entityName string) HTTPResponse

func FailedInvalidBody

func FailedInvalidBody() HTTPResponse

func FailedInvalidParam

func FailedInvalidParam(param string) HTTPResponse

func FailedInvalidQuery

func FailedInvalidQuery(query string) HTTPResponse

func FailedMissingParam

func FailedMissingParam(param string) HTTPResponse

func FailedMissingQuery

func FailedMissingQuery(query string) HTTPResponse

func FailedUpdateEntity

func FailedUpdateEntity(entityName string) HTTPResponse

func SuccessCreateEntity

func SuccessCreateEntity(entityName string, data interface{}) HTTPResponse

func SuccessDeleteEntity

func SuccessDeleteEntity(entityName string, data interface{}) HTTPResponse

func SuccessGetEntity

func SuccessGetEntity(entityName string, data interface{}) HTTPResponse

func SuccessUpdateEntity

func SuccessUpdateEntity(entityName string, data interface{}) HTTPResponse

type PokemonHTTPHandler

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

PokemonHTTPHandler provides methods for interacting with pokemon HTTP handler.

func NewPokemonHTTPHandler

func NewPokemonHTTPHandler(service domain.PokemonService) *PokemonHTTPHandler

NewPokemonHTTPHandler creates new pokemon HTTP handler.

func (*PokemonHTTPHandler) GetPokemonByName

func (h *PokemonHTTPHandler) GetPokemonByName(ctx *gin.Context)

GetPokemonByName gets a pokemon based on its name.

type ProviderHTTPHandler

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

ProviderHTTPHandler provides methods for interacting with provider HTTP handler.

func NewProviderHTTPHandler

func NewProviderHTTPHandler(service domain.ProviderService) *ProviderHTTPHandler

NewHTTPHandler creates new provider HTTP handler.

func (*ProviderHTTPHandler) CreateProvider

func (h *ProviderHTTPHandler) CreateProvider(ctx *gin.Context)

CreateProvider creates new provider.

func (*ProviderHTTPHandler) DeleteProviderByUUID

func (h *ProviderHTTPHandler) DeleteProviderByUUID(ctx *gin.Context)

DeleteProviderByUUID deletes existing provider based on its UUID.

func (*ProviderHTTPHandler) GetProviderByUUID

func (h *ProviderHTTPHandler) GetProviderByUUID(ctx *gin.Context)

GetProviderByUUID retrieves a provider based on its UUID.

func (*ProviderHTTPHandler) GetProviders

func (h *ProviderHTTPHandler) GetProviders(ctx *gin.Context)

GetProviders gets all providers.

func (*ProviderHTTPHandler) UpdateProvider

func (h *ProviderHTTPHandler) UpdateProvider(ctx *gin.Context)

UpdateProvider updates existing provider.

type UpdateProviderReq

type UpdateProviderReq struct {
	ShortName string `json:"shortName"`
	LongName  string `json:"longName"`
}

UpdateProviderReq represents JSON request for updating existing provider.