httpapi

Documentation

Index

• func BindValidate(c echo.Context, req interface{}) error
• func GetRequestID(c echo.Context) string
• type App
  • func New(name string, configPath string, addr string, instancdID int64) *App
  • func (a *App) AddGroup(g Group)
  • func (a *App) AddModule(m Module)
  • func (a *App) AddRouter(r Router)
  • func (a *App) AddValidator(key string, v validator.Func)
  • func (a *App) Init() error
  • func (a *App) ServerContext() *ServerContext
  • func (a *App) Start() error
  • func (a *App) Stop()
  • func (a *App) Use(m ...echo.MiddlewareFunc)
• type Group
  • func (g *Group) GetMiddlewares() []echo.MiddlewareFunc
• type Http2App
  • func NewHttp2App(configPath string, addr string, instancdID int64) *Http2App
  • func (a *Http2App) Init() error
  • func (a *Http2App) Start() error
• type Middleware
  • func NewMiddlewareBearerJwt(jwtSecert string) Middleware
• type MiddlewareBearerJwt
  • func (m *MiddlewareBearerJwt) GetHeaderToken(c echo.Context) (string, error)
  • func (m *MiddlewareBearerJwt) MiddlewareFunc() echo.MiddlewareFunc
• type Module
• type Response
• type Router
  • func (r *Router) GetMiddlewares() []echo.MiddlewareFunc
• type ServerContext
  • func (s *ServerContext) Add(key string, val interface{})
  • func (s *ServerContext) Get(key string) (interface{}, error)
• type StructValidator
  • func NewStructValidator() *StructValidator
  • func (s *StructValidator) AddValidator(tag string, v validator.Func) error
  • func (s *StructValidator) Validate(i interface{}) error

Functions

func BindValidate

func BindValidate(c echo.Context, req interface{}) error

BindValidate 绑定并且校验

func GetRequestID

func GetRequestID(c echo.Context) string

GetRequestID 获取RequestID

Types

type App

type App struct {
	boot.BaseInstance
	// contains filtered or unexported fields
}

App is the application entrypoint.

func New

func New(name string, configPath string, addr string, instancdID int64) *App

New creates a new application.

func (*App) AddGroup

func (a *App) AddGroup(g Group)

AddGroup adds a group to the application.

func (*App) AddModule

func (a *App) AddModule(m Module)

AddModule adds a module to the application.

func (*App) AddRouter

func (a *App) AddRouter(r Router)

AddRouter adds a router to the application.

func (*App) AddValidator

func (a *App) AddValidator(key string, v validator.Func)

AddValidator 增加自定义验证器

func (*App) Init

func (a *App) Init() error

Init 初始化阶段

func (*App) ServerContext

func (a *App) ServerContext() *ServerContext

ServerContext 获取服务的

func (*App) Start

func (a *App) Start() error

start starts the application.

func (*App) Stop

func (a *App) Stop()

Stop 停止服务

func (*App) Use

func (a *App) Use(m ...echo.MiddlewareFunc)

Use adds a middleware to the application.

type Group

type Group struct {
	Path        string       // 路径
	Middlewares []Middleware // 中间件函数
	Routers     []Router     // 路由
}

Group 路由的分组

func (*Group) GetMiddlewares

func (g *Group) GetMiddlewares() []echo.MiddlewareFunc

GetMiddlewares 获取所有注册中间件

type Http2App

type Http2App struct {
	App

	CertPemPath string // cert.pem所在文件的路径
	KeyPemPath  string // key.pem所在文件的路径
}

Hhttp2App http2协议的实现

func NewHttp2App

func NewHttp2App(configPath string, addr string, instancdID int64) *Http2App

NewHttp2App 创建一个http2协议的实现

func (*Http2App) Init

func (a *Http2App) Init() error

Init 初始化

func (*Http2App) Start

func (a *Http2App) Start() error

Start 开始

type Middleware

type Middleware interface {
	MiddlewareFunc() echo.MiddlewareFunc
}

Middleware 中间件抽象

func NewMiddlewareBearerJwt

func NewMiddlewareBearerJwt(jwtSecert string) Middleware

NewMiddlewareBearerJwt 使用Bearer Token的中间件生成器

type MiddlewareBearerJwt

type MiddlewareBearerJwt struct {
	JT *jwt.JwtToken // jwt实现
}

MiddlewareBearerJwt 使用Bearer Token的一个中间件

func (*MiddlewareBearerJwt) GetHeaderToken

func (m *MiddlewareBearerJwt) GetHeaderToken(c echo.Context) (string, error)

GetHeaderToken 从请求头获取Token

func (*MiddlewareBearerJwt) MiddlewareFunc

func (m *MiddlewareBearerJwt) MiddlewareFunc() echo.MiddlewareFunc

MiddlewareFunc 对Middleware的实现

type Module

type Module interface {
	// 初始化模块
	Init(app *App)
	// 模块的分组路由
	Group() Group
}

Module 按模块组合

type Response

type Response struct {
	Code int32 `json:"code"`
}

Response 返回结构

type Router

type Router struct {
	Method      string           // 方法
	Path        string           // 路径
	Name        string           // 名称
	Handle      echo.HandlerFunc // 处理函数
	Middlewares []Middleware     // 中间件函数
}

Router 路由

func (*Router) GetMiddlewares

func (r *Router) GetMiddlewares() []echo.MiddlewareFunc

GetMiddlewares 获取所有注册中间件

type ServerContext

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

ServerContext 服务上下文，用于各个Module之间共享资源

func (*ServerContext) Add

func (s *ServerContext) Add(key string, val interface{})

Add 加入一个共享的资源

func (*ServerContext) Get

func (s *ServerContext) Get(key string) (interface{}, error)

Get 获取被共享的资源，如果key找不到，则返回Error

type StructValidator

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

StructValidator 结构体验证器

func NewStructValidator

func NewStructValidator() *StructValidator

NewStructValidator 构建新结构体

func (*StructValidator) AddValidator

func (s *StructValidator) AddValidator(tag string, v validator.Func) error

AddValidator 增加自定义验证器

func (*StructValidator) Validate

func (s *StructValidator) Validate(i interface{}) error

Validate 实现echo.Validator