api

Documentation

Index

• Constants
• func AbortJSON(ctx *gin.Context, statusCode int, verdict string, message string, ...)
• func Recovery() gin.HandlerFunc
• func RequestIDMiddleware() gin.HandlerFunc
• func SendError(ctx *gin.Context, _ error)
• func SendJSON(ctx *gin.Context, statusCode int, verdict string, message string, ...)
• func SendSuccess(ctx *gin.Context, message string, data interface{})
• type App
  • func NewApp(ctx context.Context, config *config.Config, options ...AppOption) (*App, error)
  • func (app *App) Start(ctx context.Context) error
• type AppOption
• type StubRequestParam

Constants

const (
	VerdictSuccess           = "success"
	VerdictFailure           = "failure"
	VerdictMissingParameters = "missing_parameters"
	VerdictInvalidParameters = "invalid_parameters"
)

Functions

func AbortJSON

func AbortJSON(ctx *gin.Context, statusCode int, verdict string, message string, data interface{})

AbortJSON abort with JSON

func Recovery

func Recovery() gin.HandlerFunc

Recovery returns a middleware for a given writer that recovers from any panics and calls the provided handle func to handle it

func RequestIDMiddleware

func RequestIDMiddleware() gin.HandlerFunc

RequestIDMiddleware adds X-Request-ID value to request, response and save to context variable

func SendError

func SendError(ctx *gin.Context, _ error)

SendError sends error

func SendJSON

func SendJSON(ctx *gin.Context, statusCode int, verdict string, message string, data interface{})

SendJSON sends JSON

func SendSuccess

func SendSuccess(ctx *gin.Context, message string, data interface{})

SendSuccess sends success response

Types

type App

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

App defines app interface

func NewApp

func NewApp(ctx context.Context, config *config.Config, options ...AppOption) (*App, error)

NewApp returns new app

func (*App) Start

func (app *App) Start(ctx context.Context) error

Start starts app

type AppOption

type AppOption func(*App)

type StubRequestParam

type StubRequestParam struct {
	Stubs []*rio.Stub `json:"stubs" yaml:"stubs"`

	// Go SDK expect the response should be encoded data
	ReturnEncoded bool `json:"return_encoded" yaml:"return_encoded"`
}

StubRequestParam stub request