Files
bdrp-server/app/main/api/desc/front/app.api
2026-04-22 17:49:20 +08:00

54 lines
880 B
Plaintext

syntax = "v1"
info (
title: "APP服务"
desc: "APP服务"
version: "v1"
)
@server (
prefix: api/v1
group: app
)
service main {
@doc(
summary: "心跳检测接口"
)
@handler healthCheck
get /health/check returns (HealthCheckResp)
@handler getAppVersion
get /app/version returns (getAppVersionResp)
@doc(
summary: "获取APP全局配置"
)
@handler getAppConfig
get /app/config returns (GetAppConfigResp)
}
type (
// 心跳检测响应
HealthCheckResp {
Status string `json:"status"` // 服务状态
Message string `json:"message"` // 状态信息
}
)
type (
getAppVersionResp {
Version string `json:"version"`
WgtUrl string `json:"wgtUrl"`
}
)
type (
AppQueryConfig {
RetentionDays int64 `json:"retention_days"` // 查询结果保留天数
}
GetAppConfigResp {
Query AppQueryConfig `json:"query"` // 查询相关配置
}
)