server

README

server

server包是用于更加方便的开发web项目而封装的包，开启配置的话，如下

// main.go 文件
import (
    "github.com/gin-gonic/gin"
    "github.com/isyscore/isc-gobase/server"
    "github.com/isyscore/isc-gobase/server/rsp"
)

func main() {
    server.Get("group1/data", GetData)
    server.Run()
}

base:
  server:
    # 是否启用，默认：true
    enable: true
    # 端口号
    port: 8080
    # web框架gin的配置
    gin:
      # 有三种模式：debug/release/test
      mode: debug
    exception:
      # 异常返回打印
      print:
        # 是否启用：true, false；默认 true
        enable: true
        # 一些异常httpStatus不打印；默认可不填
        except:
          - 408
          - 409
    # 版本号设置,默认值:unknown
    version: 1.0.0
  # 内部开放的 endpoint
  endpoint:
    # 健康检查处理，默认关闭，true/false
    health:
      enable: true
    # 配置的管理（查看和变更），默认关闭，true/false
    config:
      enable: true

Documentation

Index

• Variables
• func All(path string, handler gin.HandlerFunc) gin.IRoutes
• func AllWith(path string, header []string, versionName []string, handler gin.HandlerFunc) gin.IRoutes
• func Cors() gin.HandlerFunc
• func Delete(path string, handler gin.HandlerFunc) gin.IRoutes
• func DeleteWith(path string, header []string, versionName []string, handler gin.HandlerFunc) gin.IRoutes
• func Engine() gin.IRoutes
• func Get(path string, handler gin.HandlerFunc) gin.IRoutes
• func GetPost(path string, handler gin.HandlerFunc) gin.IRoutes
• func GetPostWith(path string, header []string, versionName []string, handler gin.HandlerFunc) gin.IRoutes
• func GetWith(path string, header []string, versionName []string, handler gin.HandlerFunc) gin.IRoutes
• func Head(path string, handler gin.HandlerFunc) gin.IRoutes
• func HeadWith(path string, header []string, versionName []string, handler gin.HandlerFunc) gin.IRoutes
• func InitServer()
• func Options(path string, handler gin.HandlerFunc) gin.IRoutes
• func OptionsWith(path string, header []string, versionName []string, handler gin.HandlerFunc) gin.IRoutes
• func Post(path string, handler gin.HandlerFunc) gin.IRoutes
• func PostWith(path string, header []string, versionName []string, handler gin.HandlerFunc) gin.IRoutes
• func Put(path string, handler gin.HandlerFunc) gin.IRoutes
• func PutWith(path string, header []string, versionName []string, handler gin.HandlerFunc) gin.IRoutes
• func RegisterConfigWatchEndpoint(apiBase string) gin.IRoutes
• func RegisterCustomHealthCheck(apiBase string, status func() string, init func() string, ...) gin.IRoutes
• func RegisterHealthCheckEndpoint(apiBase string) gin.IRoutes
• func RegisterPlugin(plugin gin.HandlerFunc) gin.IRoutes
• func RegisterRoute(path string, method HttpMethod, handler gin.HandlerFunc) gin.IRoutes
• func RegisterRouteWithHeaders(path string, method HttpMethod, header []string, versionName []string, ...) gin.IRoutes
• func RegisterStatic(relativePath string, rootPath string) gin.IRoutes
• func RegisterStaticFile(relativePath string, filePath string) gin.IRoutes
• func RegisterWebSocketRoute(path string, svr *websocket.Server) gin.IRoutes
• func Run()
• func StartServer()
• type ApiPath
  • func GetApiPath(path string, method HttpMethod) *ApiPath
  • func NewApiPath(path string, method HttpMethod) *ApiPath
  • func (ap *ApiPath) AddVersion(header []string, version []string, handler gin.HandlerFunc)
• type ApiVersion
• type HttpMethod

Variables

var ApiPrefix = "/api"

var Version string = defaultVersion

Functions

func All

func All(path string, handler gin.HandlerFunc) gin.IRoutes

func AllWith

func AllWith(path string, header []string, versionName []string, handler gin.HandlerFunc) gin.IRoutes

func Cors

func Cors() gin.HandlerFunc

Cors 配置允许跨域请求

func Delete

func Delete(path string, handler gin.HandlerFunc) gin.IRoutes

func DeleteWith

func DeleteWith(path string, header []string, versionName []string, handler gin.HandlerFunc) gin.IRoutes

func Engine

func Engine() gin.IRoutes

func Get

func Get(path string, handler gin.HandlerFunc) gin.IRoutes

func GetPost

func GetPost(path string, handler gin.HandlerFunc) gin.IRoutes

func GetPostWith

func GetPostWith(path string, header []string, versionName []string, handler gin.HandlerFunc) gin.IRoutes

func GetWith

func GetWith(path string, header []string, versionName []string, handler gin.HandlerFunc) gin.IRoutes

func Head

func Head(path string, handler gin.HandlerFunc) gin.IRoutes

func HeadWith

func HeadWith(path string, header []string, versionName []string, handler gin.HandlerFunc) gin.IRoutes

func InitServer

func InitServer()

func Options

func Options(path string, handler gin.HandlerFunc) gin.IRoutes

func OptionsWith

func OptionsWith(path string, header []string, versionName []string, handler gin.HandlerFunc) gin.IRoutes

func Post

func Post(path string, handler gin.HandlerFunc) gin.IRoutes

func PostWith

func PostWith(path string, header []string, versionName []string, handler gin.HandlerFunc) gin.IRoutes

func Put

func Put(path string, handler gin.HandlerFunc) gin.IRoutes

func PutWith

func PutWith(path string, header []string, versionName []string, handler gin.HandlerFunc) gin.IRoutes

func RegisterConfigWatchEndpoint

func RegisterConfigWatchEndpoint(apiBase string) gin.IRoutes

func RegisterCustomHealthCheck

func RegisterCustomHealthCheck(apiBase string, status func() string, init func() string, destroy func() string) gin.IRoutes

func RegisterHealthCheckEndpoint

func RegisterHealthCheckEndpoint(apiBase string) gin.IRoutes

func RegisterPlugin

func RegisterPlugin(plugin gin.HandlerFunc) gin.IRoutes

func RegisterRoute

func RegisterRoute(path string, method HttpMethod, handler gin.HandlerFunc) gin.IRoutes

func RegisterRouteWithHeaders

func RegisterRouteWithHeaders(path string, method HttpMethod, header []string, versionName []string, handler gin.HandlerFunc) gin.IRoutes

func RegisterStatic

func RegisterStatic(relativePath string, rootPath string) gin.IRoutes

func RegisterStaticFile

func RegisterStaticFile(relativePath string, filePath string) gin.IRoutes

func RegisterWebSocketRoute

func RegisterWebSocketRoute(path string, svr *websocket.Server) gin.IRoutes

func Run

func Run()

func StartServer

func StartServer()

Types

type ApiPath

type ApiPath struct {
	Path     string
	Handler  gin.HandlerFunc
	Method   HttpMethod
	Versions ISCList[*ApiVersion]
}

func GetApiPath

func GetApiPath(path string, method HttpMethod) *ApiPath

func NewApiPath

func NewApiPath(path string, method HttpMethod) *ApiPath

func (*ApiPath) AddVersion

func (ap *ApiPath) AddVersion(header []string, version []string, handler gin.HandlerFunc)

type ApiVersion

type ApiVersion struct {
	Header  []string
	Version []string
	Handler gin.HandlerFunc
}

type HttpMethod

type HttpMethod int

const (
	HmAll HttpMethod = iota
	HmGet
	HmPost
	HmPut
	HmDelete
	HmOptions
	HmHead
	HmGetPost
)