api

type API struct {
	shared.HeaderList

	Filename       string      `yaml:"filename" json:"filename"`             // 文件名
	Path           string      `yaml:"path" json:"path"`                     // 访问路径
	Address        string      `yaml:"address" json:"address"`               // 实际地址
	Methods        []string    `yaml:"methods" json:"methods"`               // 方法
	Params         []*APIParam `yaml:"params" json:"params"`                 // 参数
	Name           string      `yaml:"name" json:"name"`                     // 名称
	Description    string      `yaml:"description" json:"description"`       // 描述
	MockFiles      []string    `yaml:"mockFiles" json:"mockFiles"`           // 假数据文件（Mock）
	MockOn         bool        `yaml:"mockOn" json:"mockOn"`                 // 是否开启Mock
	Author         string      `yaml:"author" json:"author"`                 // 作者
	Company        string      `yaml:"company" json:"company"`               // 公司或团队
	IsAsynchronous bool        `yaml:"isAsynchronous" json:"isAsynchronous"` // TODO
	Timeout        float64     `yaml:"timeout" json:"timeout"`               // TODO
	MaxSize        uint        `yaml:"maxSize" json:"maxSize"`               // TODO
	TodoThings     []string    `yaml:"todo" json:"todo"`                     // 待做事宜
	DoneThings     []string    `yaml:"done" json:"done"`                     // 已完成事宜
	Response       []byte      `yaml:"response" json:"response"`             // 响应内容 TODO
	IsDeprecated   bool        `yaml:"isDeprecated" json:"isDeprecated"`     // 是否过期
	On             bool        `yaml:"on" json:"on"`                         // 是否开启
	Versions       []string    `yaml:"versions" json:"versions"`             // 版本信息
	ModifiedAt     int64       `yaml:"modifiedAt" json:"modifiedAt"`         // 最后修改时间
	Username       string      `yaml:"username" json:"username"`             // 最后修改用户名
	Groups         []string    `yaml:"groups" json:"groups"`                 // 分组
	Limit          *APILimit   `yaml:"limit" json:"limit"`                   // 限制 TODO
	AuthType       string      `yaml:"authType" json:"authType"`             // 认证方式

	TestScripts   []string `yaml:"testScripts" json:"testScripts"`     // 脚本文件
	TestCaseFiles []string `yaml:"testCaseFiles" json:"testCaseFiles"` // 单元测试存储文件

	CachePolicy string `yaml:"cachePolicy" json:"cachePolicy"` // 缓存策略
	CacheOn     bool   `yaml:"cacheOn" json:"cacheOn"`         // 缓存是否打开 TODO
	// contains filtered or unexported fields
}

type APIAuthBasicAuth struct {
	Username string
	Password string
}

type APIAuthInterface interface {
	// 唯一Key
	UniqueKey() string

	// 从Request中读取Key
	KeyFromRequest(req *http.Request) string

	// 匹配Request
	MatchRequest(req *http.Request) bool
}

type APIAuthKeyAuth struct {
	Key         string
	HeaderField string
	FormField   string
}

type APIAuthNoneAuth struct {
}

type APIConfig struct {
	On             bool         `yaml:"on" json:"on"`                         // 是否开启API功能
	Files          []string     `yaml:"files" json:"files"`                   // API文件列表
	Groups         []string     `yaml:"groups" json:"groups"`                 // API分组
	Versions       []string     `yaml:"versions" json:"versions"`             // API版本
	TestPlans      []string     `yaml:"testPlans" json:"testPlans"`           // API测试计划
	StatusList     []*APIStatus `yaml:"status" json:"status"`                 // 状态码列表
	StatusScriptOn bool         `yaml:"statusScriptOn" json:"statusScriptOn"` // 是否开启状态码分析脚本
	StatusScript   string       `yaml:"statusScript" json:"statusScript"`     // 状态码分析脚本
	MockOn         bool         `yaml:"mockOn" json:"mockOn"`                 // 是否开启Mock
	ConsumerFiles  []string     `yaml:"consumerFiles" json:"consumerFiles"`   // 消费者（调用的开发者）
	// contains filtered or unexported fields
}

type APIConsumer struct {
	Filename string `yaml:"filename" json:"filename"` // 文件名
	On       bool   `yaml:"on" json:"on"`             // 是否开启 TODO
	Name     string `yaml:"name" json:"name"`         // 名称

	// 认证
	Auth struct {
		On      bool                   `yaml:"on" json:"on"`           // 是否开启 TODO
		Type    string                 `yaml:"type" json:"type"`       // 类型
		Options map[string]interface{} `yaml:"options" json:"options"` // 选项
	} `yaml:"auth" json:"auth"`

	// API控制
	API struct {
		On       bool     `yaml:"on" json:"on"`             // 是否开启
		AllowAll bool     `yaml:"allowAll" json:"allowAll"` // 是否允许所有
		DenyAll  bool     `yaml:"denyAll" json:"denyAll"`   // 是否禁止所有
		Allow    []string `yaml:"allow" json:"allow"`       // 允许的API
		Deny     []string `yaml:"deny" json:"deny"`         // 禁止的API
	} `yaml:"api" json:"api"` // API控制

	Policy shared.AccessPolicy `yaml:"policy" json:"policy"` // 控制策略
}

type APIDataLimit struct {
	Max      uint   `yaml:"max" json:"max"`           // 最大数据量 TODO
	Total    uint   `yaml:"total" json:"total"`       // 数据量 TODO
	Duration string `yaml:"duration" json:"duration"` // 数据限制间隔 TODO
	// contains filtered or unexported fields
}

type APILimit struct {
	Concurrent    uint               `yaml:"concurrent" json:"concurrent"` // 并发数
	RequestLimits []*APIRequestLimit `yaml:"request" json:"request"`       // 请求数限制 TODO
	DataLimits    []*APIDataLimit    `yaml:"data" json:"data"`             // 数据量限制 TODO
	// contains filtered or unexported fields
}

type APIMock struct {
	Filename  string     `yaml:"filename" json:"filename"`   // 保存的文件名
	On        bool       `yaml:"on" json:"on"`               // 是否开启
	Headers   []maps.Map `yaml:"headers" json:"headers"`     // 输出的Header
	Format    string     `yaml:"format" json:"format"`       // 格式
	Text      string     `yaml:"text" json:"text"`           // 文本
	File      string     `yaml:"file" json:"file"`           // 文件名，一般是和文本二选一
	Username  string     `yaml:"username" json:"username"`   // 创建的用户名
	CreatedAt int64      `yaml:"createdAt" json:"createdAt"` // 创建时间
}

type APIParam struct {
	Name        string `yaml:"name" json:"name"`
	Type        string `yaml:"type" json:"type"`
	Description string `yaml:"description" json:"description"`
}

type APIRequestLimit struct {
	Count    uint   `yaml:"count" json:"count"`       // 请求数 TODO
	Duration string `yaml:"duration" json:"duration"` // 请求限制间隔 TODO
	// contains filtered or unexported fields
}

type APIScript struct {
	Filename string `yaml:"filename" json:"filename"` // 脚本路径
	Code     string `yaml:"code" json:"code"`         // 代码
}

type APIStatus struct {
	Code        string   `yaml:"code" json:"code"`               // 代码
	Description string   `yaml:"description" json:"description"` // 描述
	Groups      []string `yaml:"groups" json:"groups"`           // 分组
	Versions    []string `yaml:"versions" json:"versions"`       // 版本
	Type        string   `yaml:"type" json:"type"`               // 类型
}

type APITestCase struct {
	Filename     string     `yaml:"filename" json:"filename"`         // 文件名
	Name         string     `yaml:"name" json:"name"`                 // 名称
	Domain       string     `yaml:"domain" json:"domain"`             // 域名
	Method       string     `yaml:"method" json:"method"`             // 方法
	Query        string     `yaml:"query" json:"query"`               // URL附加参数
	Headers      []maps.Map `yaml:"headers" json:"headers"`           // Header
	Params       []maps.Map `yaml:"params" json:"params"`             // 内置参数
	AttachParams []maps.Map `yaml:"attachParams" json:"attachParams"` // 附加参数
	Format       string     `yaml:"format" json:"format"`             // 响应格式
	Username     string     `yaml:"username" json:"username"`         // 用户名
	CreatedAt    int64      `yaml:"createdAt" json:"createdAt"`       // 创建时间
	UpdatedAt    int64      `yaml:"updatedAt" json:"updatedAt"`       // 更新时间
}

type APITestPlan struct {
	On       bool     `yaml:"on" json:"on"`             // 是否开启
	Filename string   `yaml:"filename" json:"filename"` // 配置文件名
	Hour     int      `yaml:"hour" json:"hour"`         // 小时
	Minute   int      `yaml:"minute" json:"minute"`     // 分钟
	Second   int      `yaml:"second" json:"second"`     // 秒
	Weekdays []int    `yaml:"weekdays" json:"weekdays"` // 周
	Reports  []string `yaml:"reports" json:"reports"`   // 报告文件名
	APIs     []string `yaml:"apis" json:"apis"`         // 参与计划的API TODO 需要实现
}

type APITestPlanReport struct {
	Filename     string           `yaml:"filename" json:"filename"`         // 文件名
	StartedAt    int64            `yaml:"startedAt" json:"startedAt"`       // 开始时间
	FinishedAt   int64            `yaml:"finishedAt" json:"finishedAt"`     // 结束时间
	TotalAPIs    int              `yaml:"totalApis" json:"totalApis"`       // 总体API数量
	TotalScripts int              `yaml:"totalScripts" json:"totalScripts"` // 总体脚本总数
	Results      []*APITestResult `yaml:"results" json:"results"`           // 统计
	// contains filtered or unexported fields
}

type APITestResult struct {
	API      string                 `yaml:"api" json:"api"`           // API
	Scripts  []*APITestScriptResult `yaml:"scripts" json:"scripts"`   // 脚本
	IsPassed bool                   `yaml:"isPassed" json:"isPassed"` // 是否通过测试
}

type APITestScriptResult struct {
	Code     string   `yaml:"code" json:"code"`         // 脚本代码
	IsPassed bool     `yaml:"isPassed" json:"isPassed"` // 是否通过测试
	Failures []string `yaml:"failures" json:"failures"` // 失败
}

type APIVersion struct {
	Name string `yaml:"name" json:"name"`
	Code string `yaml:"code" json:"code"`
	On   bool   `yaml:"on" json:"on"`
}

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