Files
hldrCenter/server/api/social/socical_service_governmentprogram/social_service_governmentprogram.api
2025-11-01 23:38:51 +08:00

137 lines
6.5 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
// 通用基础响应结构不含泛型兼容Goctl
type BaseResp {
Code int `json:"code"` // 状态码0成功非0失败
Msg string `json:"message"` // 提示信息
}
// 社会服务政府项目实体结构(与表字段对应)
type SocialServiceGovernmentProgram {
Id int64 `json:"id"` // 主键ID
Title string `json:"title"` // 标题
Subtitle string `json:"subtitle,omitempty"` // 副标题
CoverUrl string `json:"cover_url,omitempty"` // 封面图片URL
Intro string `json:"intro,omitempty"` // 简介(纯文字)
Content string `json:"content,omitempty"` // 内容Markdown格式
ImageEditors string `json:"image_editors,omitempty"` // 图片编辑者名单(逗号分隔)
TextEditors string `json:"text_editors,omitempty"` // 文字编辑者名单(逗号分隔)
ChiefEditor string `json:"chief_editor,omitempty"` // 总编辑
Proofreaders string `json:"proofreaders,omitempty"` // 校对者名单(逗号分隔)
Reviewers string `json:"reviewers,omitempty"` // 审核者名单(逗号分隔)
PublishTime string `json:"publish_time"` // 发布时间格式yyyy-MM-dd HH:mm:ss
UpdateTime string `json:"update_time"` // 最后更改时间格式yyyy-MM-dd HH:mm:ss
}
// 创建社会服务政府项目 - 请求参数
type CreateSocialServiceGovernmentProgramReq {
Title string `json:"title" validate:"required"` // 标题(必填)
Subtitle string `json:"subtitle,omitempty"` // 副标题
CoverUrl string `json:"cover_url,omitempty"` // 封面图片URL
Intro string `json:"intro,omitempty"` // 简介(纯文字)
Content string `json:"content,omitempty"` // 内容Markdown格式
ImageEditors string `json:"image_editors,omitempty"` // 图片编辑者名单(逗号分隔)
TextEditors string `json:"text_editors,omitempty"` // 文字编辑者名单(逗号分隔)
ChiefEditor string `json:"chief_editor,omitempty"` // 总编辑
Proofreaders string `json:"proofreaders,omitempty"` // 校对者名单(逗号分隔)
Reviewers string `json:"reviewers,omitempty"` // 审核者名单(逗号分隔)
}
// 创建社会服务政府项目 - 响应参数(嵌套数据,无泛型)
type CreateSocialServiceGovernmentProgramResp {
Code int `json:"code"`
Msg string `json:"message"`
Data CreateSocialServiceGovernmentProgramData `json:"data,omitempty"`
}
type CreateSocialServiceGovernmentProgramData {
Id int64 `json:"id"` // 新增记录的ID
}
// 获取社会服务政府项目列表 - 请求参数
type ListSocialServiceGovernmentProgramReq {
Page int `json:"page" form:"page" validate:"min=1"` // 页码默认1
PageSize int `json:"page_size" form:"page_size" validate:"min=1,max=100"` // 每页条数默认10最大100
}
// 获取社会服务政府项目列表 - 响应参数(嵌套数据,无泛型)
type ListSocialServiceGovernmentProgramResp {
Code int `json:"code"`
Msg string `json:"message"`
Data ListSocialServiceGovernmentProgramData `json:"data,omitempty"`
}
type ListSocialServiceGovernmentProgramData {
Total int64 `json:"total"` // 总条数
List []SocialServiceGovernmentProgram `json:"list"` // 列表数据
}
// 获取社会服务政府项目详情 - 请求参数(路径参数)
type GetSocialServiceGovernmentProgramReq {
Id int64 `json:"id" path:"id" validate:"min=1"` // 社会服务政府项目ID必填
}
// 获取社会服务政府项目详情 - 响应参数(嵌套数据,无泛型)
type GetSocialServiceGovernmentProgramResp {
Code int `json:"code"`
Msg string `json:"message"`
Data SocialServiceGovernmentProgram `json:"data,omitempty"`
}
// 更新社会服务政府项目 - 请求参数
type UpdateSocialServiceGovernmentProgramReq {
Id int64 `json:"-" path:"id" validate:"min=1"` // 社会服务政府项目ID路径参数必填
Title string `json:"title,omitempty"` // 标题
Subtitle string `json:"subtitle,omitempty"` // 副标题
CoverUrl string `json:"cover_url,omitempty"` // 封面图片URL
Intro string `json:"intro,omitempty"` // 简介(纯文字)
Content string `json:"content,omitempty"` // 内容Markdown格式
ImageEditors string `json:"image_editors,omitempty"` // 图片编辑者名单(逗号分隔)
TextEditors string `json:"text_editors,omitempty"` // 文字编辑者名单(逗号分隔)
ChiefEditor string `json:"chief_editor,omitempty"` // 总编辑
Proofreaders string `json:"proofreaders,omitempty"` // 校对者名单(逗号分隔)
Reviewers string `json:"reviewers,omitempty"` // 审核者名单(逗号分隔)
}
// 更新社会服务政府项目 - 响应参数(基础响应,无额外数据)
type UpdateSocialServiceGovernmentProgramResp {
Code int `json:"code"`
Msg string `json:"message"`
}
// 删除社会服务政府项目 - 请求参数(路径参数)
type DeleteSocialServiceGovernmentProgramReq {
Id int64 `json:"id" path:"id" validate:"min=1"` // 社会服务政府项目ID必填
}
// 删除社会服务政府项目 - 响应参数(基础响应,无额外数据)
type DeleteSocialServiceGovernmentProgramResp {
Code int `json:"code"`
Msg string `json:"message"`
}
@server (
group: socialServiceGovernmentProgram
prefix: /api/social-service/government-program // 统一前缀,区分政府项目相关接口
)
service social_service_governmentprogram_api {
// 创建社会服务政府项目
@handler CreateSocialServiceGovernmentProgramHandler
post / (CreateSocialServiceGovernmentProgramReq) returns (CreateSocialServiceGovernmentProgramResp)
// 获取社会服务政府项目列表
@handler ListSocialServiceGovernmentProgramHandler
get /list (ListSocialServiceGovernmentProgramReq) returns (ListSocialServiceGovernmentProgramResp)
// 获取社会服务政府项目详情
@handler GetSocialServiceGovernmentProgramHandler
get /:id (GetSocialServiceGovernmentProgramReq) returns (GetSocialServiceGovernmentProgramResp)
// 更新社会服务政府项目
@handler UpdateSocialServiceGovernmentProgramHandler
put /:id (UpdateSocialServiceGovernmentProgramReq) returns (UpdateSocialServiceGovernmentProgramResp)
// 删除社会服务政府项目
@handler DeleteSocialServiceGovernmentProgramHandler
delete /:id (DeleteSocialServiceGovernmentProgramReq) returns (DeleteSocialServiceGovernmentProgramResp)
}