gin

Documentation

Overview

Package gin - GIN 기반의 Routing 기능 제공 패키지

Index

• Constants
• func CustomErrorEndpointHandler(eConf *config.EndpointConfig, proxy proxy.Proxy, errF router.ToHTTPError) gin.HandlerFunc
• func DebugHandler(logger logging.Logger) gin.HandlerFunc
• func EndpointHandler(eConf *config.EndpointConfig, proxy proxy.Proxy) gin.HandlerFunc
• func New(sConf *config.ServiceConfig, opts ...Option) router.Router
• func NewRequest(eConf *config.EndpointConfig) func(*gin.Context, []string) *proxy.Request
• type HandlerFactory
• type Option
  • func WithHandlerFactory(hf HandlerFactory) Option
  • func WithLogger(logger logging.Logger) Option
  • func WithProxyFactory(pf proxy.Factory) Option
• type PipeConfig
  • func (pc *PipeConfig) Engine() http.Handler
  • func (pc *PipeConfig) RegisterAPIs(sConf *config.ServiceConfig, defs []*config.EndpointConfig) error
  • func (pc *PipeConfig) UpdateEngine(sConf *config.ServiceConfig)
• type Render

Constants

const (
	// NEGOTIATE - Backend의 Response 포맷과 Endpoint의 "OutputEncoding" 협상을 위한 식별자
	NEGOTIATE = "nogotiate"
)

Functions

func CustomErrorEndpointHandler

func CustomErrorEndpointHandler(eConf *config.EndpointConfig, proxy proxy.Proxy, errF router.ToHTTPError) gin.HandlerFunc

CustomErrorEndpointHandler - 지정한 Endpoint 설정과 수행할 Proxy 정보 및 오류 처리를 위한 Gin Framework handler 생성

func DebugHandler

func DebugHandler(logger logging.Logger) gin.HandlerFunc

DebugHandler - debug 테스트를 위한 log 출력용 Handler 구성

func EndpointHandler

func EndpointHandler(eConf *config.EndpointConfig, proxy proxy.Proxy) gin.HandlerFunc

EndpointHandler - 지정된 Endpoint 설정과 Proxy를 연계 호출하는 Gin Framework handler 생성

func New

func New(sConf *config.ServiceConfig, opts ...Option) router.Router

New - PipeConfig 인스턴스 생성

func NewRequest

func NewRequest(eConf *config.EndpointConfig) func(*gin.Context, []string) *proxy.Request

NewRequest - 제외할 Header 정보와 Query string 정보를 반영하는 Gin Context 기반의 Request 생성

Types

type HandlerFactory

type HandlerFactory func(*config.EndpointConfig, proxy.Proxy) gin.HandlerFunc

HandlerFactory - 지정된 Endpoint 설정과 Proxy 를 기반으로 동작하는 Gin Framework handler 팩토리 정의

type Option

type Option func(*PipeConfig)

Option - Server 인스턴스에 옵션을 설정하는 함수 형식

func WithHandlerFactory

func WithHandlerFactory(hf HandlerFactory) Option

WithHandlerFactory - Route Handler Factory 설정

func WithLogger

func WithLogger(logger logging.Logger) Option

WithLogger - Logger 인스턴스 설정

func WithProxyFactory

func WithProxyFactory(pf proxy.Factory) Option

WithProxyFactory - Proxy Factory 설정

type PipeConfig

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

PipeConfig - 서비스 운영에 필요한 Pipeline 을 구성하기 위한 구조

func (*PipeConfig) Engine

func (pc *PipeConfig) Engine() http.Handler

Engine - Router 기능을 처리하는 Gin Engine 반환 (http.Handler)

func (*PipeConfig) RegisterAPIs

func (pc *PipeConfig) RegisterAPIs(sConf *config.ServiceConfig, defs []*config.EndpointConfig) error

RegisterAPIs - API Provider (Repository)에서 추출된 API 설정들을 Router로 등록

func (*PipeConfig) UpdateEngine

func (pc *PipeConfig) UpdateEngine(sConf *config.ServiceConfig)

UpdateEngine - API 변경 적용을 위한 Gin Engine 재 생성

type Render

type Render func(*gin.Context, *proxy.Response)

Render - Proxy 수행의 결과인 Response에 대한 Encoding과 Rendering 함수 정의