http

type Builder ¶ added in v0.2.0

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

Builder 提供面向调用方的 HTTP server DSL，隐藏 runtime graph 细节。

func NewBuilder() *Builder

func (b *Builder) Build(ctx context.Context) (*khttp.Server, error)

func (b *Builder) MustBuild() *khttp.Server

func (b *Builder) WithCORS(cors *conf.CORS) *Builder

func (b *Builder) WithConfig(c *conf.Server_HTTP) *Builder

func (b *Builder) WithHealthCheck(h *health.Handler) *Builder

func (b *Builder) WithLogger(l log.Logger) *Builder

func (b *Builder) WithMetrics(metrics *telemetry.Metrics) *Builder

func (b *Builder) WithMiddleware(mw ...middleware.Middleware) *Builder

func (b *Builder) WithServices(registrars ...Registrar) *Builder

func (b *Builder) WithSwagger(spec []byte, opts ...swagger.Option) *Builder

type Plugin ¶ added in v0.2.0

type Plugin struct{}

Plugin 将 HTTP server 适配到 transport runtime graph。

func (p *Plugin) Build(_ context.Context, in runtime.ServerBuildInput) (runtime.Server, error)

func (p *Plugin) Type() string

type Registrar ¶

type Registrar func(*khttp.Server)

type ServerConfig ¶ added in v0.2.3

type ServerConfig struct {
	HTTP           *conf.Server_HTTP
	CORS           *conf.CORS
	Metrics        *telemetry.Metrics
	HealthHandler  *health.Handler
	SwaggerSpec    []byte
	SwaggerOptions []swagger.Option
}

ServerConfig 封装 HTTP server plugin 的完整配置，含 proto 配置和运行时注入项。 通过 Builder 构造后作为 runtime.ServerBuildInput.Config 传入 Plugin.Build。

type ServerOption ¶

type ServerOption func(*serverOptions)

func WithCORS(c *conf.CORS) ServerOption

func WithConfig(c *conf.Server_HTTP) ServerOption

func WithHealthCheck(h *health.Handler) ServerOption

func WithLogger(l log.Logger) ServerOption

func WithMetrics(m *telemetry.Metrics) ServerOption

func WithMiddleware(mw ...middleware.Middleware) ServerOption

func WithServices(registrars ...Registrar) ServerOption

func WithSwagger(specData []byte, opts ...swagger.Option) ServerOption