endpoint

type ACCESS_MODE uint8

type DescribeEndpointRequest struct {
	apps.GetRequest
}

type Endpoint struct {
	// 基础数据
	apps.ResourceMeta
	// 路由条目信息
	RouteEntry `bson:",inline" validate:"required"`
}

type QueryEndpointRequest struct {
	Services []string `form:"services" json:"serivces"`
}

type RegistryEndpointRequest struct {
	Items []*RouteEntry `json:"items"`
}

type RouteEntry struct {
	// 该功能属于那个服务
	UUID string `json:"uuid" bson:"uuid" gorm:"column:uuid;type:varchar(100);uniqueIndex" optional:"true" description:"路由UUID"`
	// 该功能属于那个服务
	Service string `` /* 129-byte string literal not displayed */
	// 服务那个版本的功能
	Version string `` /* 139-byte string literal not displayed */
	// 资源名称
	Resource string `json:"resource" bson:"resource" gorm:"column:resource;type:varchar(100);index" description:"资源名称"`
	// 资源操作
	Action string `json:"action" bson:"action" gorm:"column:action;type:varchar(100);index" description:"资源操作"`
	// 读或者写
	AccessMode ACCESS_MODE `` /* 128-byte string literal not displayed */
	// 操作标签
	ActionLabel string `json:"action_label" gorm:"column:action_label;type:varchar(200);index" optional:"true" description:"资源标签"`
	// 函数名称
	FunctionName string `` /* 131-byte string literal not displayed */
	// HTTP path 用于自动生成http api
	Path string `json:"path" bson:"path" gorm:"column:path;type:varchar(200);index" description:"接口的路径"`
	// HTTP method 用于自动生成http api
	Method string `json:"method" bson:"method" gorm:"column:method;type:varchar(100);index" description:"接口的方法"`
	// 接口说明
	Description string `json:"description" bson:"description" gorm:"column:description;type:text" optional:"true" description:"接口说明"`
	// 是否校验用户身份 (acccess_token 校验)
	RequiredAuth bool `` /* 163-byte string literal not displayed */
	// 验证码校验(开启双因子认证需要) (code 校验)
	RequiredCode bool `` /* 174-byte string literal not displayed */
	// 开启鉴权
	RequiredPerm bool `` /* 128-byte string literal not displayed */
	// ACL模式下, 允许的通过的身份标识符, 比如角色, 用户类型之类
	RequiredRole []string `` /* 207-byte string literal not displayed */
	// 是否开启操作审计, 开启后这次操作将被记录
	RequiredAudit bool `` /* 178-byte string literal not displayed */
	// 名称空间不能为空
	RequiredNamespace bool `` /* 155-byte string literal not displayed */
	// 扩展信息
	Extras map[string]string `json:"extras" bson:"extras" gorm:"column:extras;serializer:json;type:json" optional:"true" description:"扩展信息"`
}

type Service interface {
	// 查询API接口列表
	QueryEndpoint(context.Context, *QueryEndpointRequest) (*types.Set[*Endpoint], error)
	// 查询API接口详情
	DescribeEndpoint(context.Context, *DescribeEndpointRequest) (*Endpoint, error)
	// 注册API接口
	RegistryEndpoint(context.Context, *RegistryEndpointRequest) (*types.Set[*Endpoint], error)
}