Documentation
¶
Index ¶
- Constants
- Variables
- func About(c *gin.Context)
- func Comment(c *gin.Context)
- func FundCheck(c *gin.Context)
- func FundFilter(c *gin.Context)
- func FundIndex(c *gin.Context)
- func FundSimilarity(c *gin.Context)
- func Materials(c *gin.Context)
- func Ping(c *gin.Context)
- func QueryFundByStock(c *gin.Context)
- func Register(httpHandler http.Handler)
- func Routes(app *gin.Engine)
- func StockChecker(c *gin.Context)
- func StockIndex(c *gin.Context)
- func StockSelector(c *gin.Context)
- type AllMaterialsList
- type MaterialItem
- type MaterialSeries
- type ParamFundCheck
- type ParamFundFilter
- type ParamFundIndex
- type ParamFundSimilarity
- type ParamQueryFundByStock
- type ParamStockChecker
- type ParamStockSelector
- type TypedMaterialSeries
Constants ¶
const (
// DisableGinSwaggerEnvkey 设置该环境变量时关闭 swagger 文档
DisableGinSwaggerEnvkey = "DISABLE_GIN_SWAGGER"
)
Variables ¶
var MaterialsFilename = "./materials.json"
MaterialsFilename 资料JSON文件路径
Functions ¶
func Ping ¶
Ping godoc @Summary 默认的 Ping 接口 @Description 返回 server 相关信息,可以用于健康检查 @Tags x @Accept json @Produce json @Success 200 {object} response.Response @Security ApiKeyAuth @Security BasicAuth @Param trace_id header string false "you can set custom trace id in header" @Router /x/ping [get]
Types ¶
type AllMaterialsList ¶
type AllMaterialsList []TypedMaterialSeries
AllMaterialsList 包含全部资料信息的大JSON列表 [
TypedMaterialSeries, ...
]
type MaterialItem ¶
type MaterialItem struct {
Name string `json:"name"`
DownloadURL string `json:"download_url"`
Desc string `json:"desc"`
}
MaterialItem 学习资料具体信息
type MaterialSeries ¶
type MaterialSeries map[string][]MaterialItem
MaterialSeries 某一个系列的资料
{
"飙股在线等": [
MaterialItem, ...
]
}
type ParamFundCheck ¶
type ParamFundCheck struct {
// 基金代码
Code string `json:"fundcode" form:"fundcode"`
// 基金规模最小值(亿)
MinScale float64 `json:"min_scale" form:"min_scale"`
// 基金规模最大值(亿)
MaxScale float64 `json:"max_scale" form:"max_scale"`
// 基金经理管理该基金最低年限
MinManagerYears float64 `json:"min_manager_years" form:"min_manager_years"`
// 最近一年收益率排名比
Year1RankRatio float64 `json:"year_1_rank_ratio" form:"year_1_rank_ratio"`
// 今年来、最近两年、最近三年、最近五年收益率排名比
ThisYear235RankRatio float64 `json:"this_year_235_rank_ratio" form:"this_year_235_rank_ratio"`
// 最近六月收益率排名比
Month6RankRatio float64 `json:"month_6_rank_ratio" form:"month_6_rank_ratio"`
// 最近三月收益率排名比
Month3RankRatio float64 `json:"month_3_rank_ratio" form:"month_3_rank_ratio"`
// 1,3,5年波动率平均值的最大值
Max135AvgStddev float64 `json:"max_135_avg_stddev" form:"max_135_avg_stddev"`
// 1,3,5年夏普比率平均值的最小值
Min135AvgSharp float64 `json:"min_135_avg_sharp" form:"min_135_avg_sharp"`
// 1,3,5年最大回撤率平均值的最大值
Max135AvgRetr float64 `json:"max_135_avg_retr" form:"max_135_avg_retr"`
// 是否检测持仓个股
CheckStocks bool `json:"check_stocks" form:"check_stocks"`
// 股票检测参数
StockCheckerOptions core.CheckerOptions
}
ParamFundCheck FundCheck 请求参数
type ParamFundFilter ¶
type ParamFundFilter struct {
ParamFundListFilter models.ParamFundListFilter
ParamFundIndex ParamFundIndex
}
ParamFundFilter FundFilter 请求参数
type ParamFundIndex ¶
type ParamFundIndex struct {
PageNum int `json:"page_num" form:"page_num"`
PageSize int `json:"page_size" form:"page_size"`
Sort int `json:"sort" form:"sort"`
Type string `json:"type" form:"type"`
}
ParamFundIndex FundIndex 请求参数
type ParamFundSimilarity ¶
type ParamFundSimilarity struct {
Codes string `json:"codes" form:"codes"`
}
ParamFundSimilarity FundSimilarity 请求参数
type ParamQueryFundByStock ¶
type ParamQueryFundByStock struct {
Keywords string `form:"keywords" binding:"required"`
}
ParamQueryFundByStock QueryFundByStock 请求参数
type ParamStockChecker ¶
type ParamStockChecker struct {
Keyword string `form:"checker_keyword"`
CheckerOptions core.CheckerOptions
}
ParamStockChecker StockChecker 请求参数
type ParamStockSelector ¶
type ParamStockSelector struct {
Filter eastmoney.Filter
CheckerOptions core.CheckerOptions
FilterWithChecker bool `form:"selector_with_checker"`
}
ParamStockSelector StockSelector 请求参数
type TypedMaterialSeries ¶
type TypedMaterialSeries map[string][]MaterialSeries
TypedMaterialSeries 对MaterialSeries进行分类,如:视频、电子书等
{
"videos": [
MaterialSeries, ...
],
"ebooks": [
MaterialSeries, ...
]
}
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag
|
Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag |
|
Package response 提供统一的 JSON 返回结构,可以通过配置设置具体返回的 code 字段为 int 或者 string
|
Package response 提供统一的 JSON 返回结构,可以通过配置设置具体返回的 code 字段为 int 或者 string |