conf

Documentation

Index

• Constants
• type Api
• type Config
• type GoCore
  • func GetGocoreConfig() *GoCore
• type Handle
• type HttpApi
• type Job
• type Model
• type Mysql
• type MysqlDb
• type Param
• type Redis
• type Service

Constants

const (
	PROJECT_NAME    = "gocore"
	PROJECT_VERSION = "v2.0.1"
)

配置常量

Types

type Api

type Api struct {
	Prefix     string   `yaml:"prefix"`     //路由前缀
	ModuleName string   `yaml:"moduleName"` // 模块名
	Handle     []Handle `yaml:"handle"`
}

type Config

type Config struct {
	CNacos          bool    `yaml:"cNacos"`
	CRocketMQConfig bool    `yaml:"cRocketMQConfig"`
	CMysql          []Mysql `yaml:"cMysql"`
	CRedis          []Redis `yaml:"cRedis"`
}

type GoCore

type GoCore struct {
	Service       Service `yaml:"service"`
	Config        Config  `yaml:"config"`
	HttpApiEnable bool    `yaml:"httpApiEnable"` // 是否开启HttpApi，开启后生成接口表示层
	RPCEnable     bool    `yaml:"rpcEnable"`     // 是否开启 rpc server,开启后生成rpc服务器表示层
	JobEnable     bool    `yaml:"jobEnable"`     // 是否开启 Job 任务
	HttpApis      HttpApi `yaml:"httpApis"`
	Jobs          []Job   `yaml:"jobs"`
}

func GetGocoreConfig

func GetGocoreConfig() *GoCore

type Handle

type Handle struct {
	Name           string  `yaml:"name"`           // 接口名
	Method         string  `yaml:"method"`         // Get Post Any
	RequestParams  []Param `yaml:"requestParams"`  // 请求参数列表
	ResponseParams []Param `yaml:"responseParams"` // 返回参数列表
	Comment        string  `yaml:"comment"`        //接口描述
}

type HttpApi

type HttpApi struct {
	Host   string             `yaml:"host"` // 地址
	Port   string             `yaml:"port"` // 端口
	Apis   []Api              `yaml:"apis"`
	Params map[string][]Param `yaml:"params"`
}

HttpApi 路由拼接规则 /public/v1/项目名/模块名/接口名 TODO: swagger.json导入

type Job

type Job struct {
	Name    string `yaml:"name"` // 任务名称
	Comment string `yaml:"comment"`
}

type Model

type Model struct {
	Name    string   `yaml:"name"`   // 表名
	Auto    bool     `yaml:"auto"`   // 是否自动创建表结构
	Fields  []string `yaml:"fields"` // 字段列表
	Comment string   `yaml:"comment"`
}

type Mysql

type Mysql struct {
	Name      string  `yaml:"name"` // Mysql名称，默认default
	HotUpdate bool    `yaml:"hotUpdate"`
	Models    []Model `yaml:"models"`
}

type MysqlDb

type MysqlDb struct {
	Host     string   `yaml:"host"`
	Port     string   `yaml:"port"`
	User     string   `yaml:"user"`
	Password string   `yaml:"password"`
	Database string   `yaml:"database"`
	Tables   []string `yaml:"tables"`
}

type Param

type Param struct {
	Name     string `yaml:"name"`
	Type     string `yaml:"type"`
	Comment  string `yaml:"comment"`
	Validate string `yaml:"validate"`
}

type Redis

type Redis struct {
	Name      string         `yaml:"name"` // Redis名称，默认default
	HotUpdate bool           `yaml:"hotUpdate"`
	Index     map[string]int `yaml:"index"` // index和Key的映射关系
}

type Service

type Service struct {
	ProjectName string `yaml:"projectName"` // 项目名称
	Version     string `yaml:"version"`     // 项目版本
}