竹简文档
响应处理

通用返回结构

BaseResponse 是 Bamboo Base Go 的统一响应结构体,确保所有 API 返回格式一致。

BaseResponse

BaseResponse 是所有 API 响应的统一结构体,位于 xBase 包根目录。

base_response.go
package xBase

type BaseResponse struct {
    Context      string            `json:"context"`
    Output       string            `json:"output"`
    Code         uint              `json:"code"`
    Message      string            `json:"message"`
    ErrorMessage xError.ErrMessage `json:"error_message,omitempty"`
    Overhead     int64             `json:"overhead,omitempty"`
    Data         interface{}       `json:"data,omitempty"`
}

字段说明

字段

类型

响应格式示例

成功响应(无数据)

{
  "context": "req_abc123",
  "output": "Success",
  "code": 200,
  "message": "操作成功",
  "overhead": 1234
}

成功响应(有数据)

{
  "context": "req_abc123",
  "output": "Success",
  "code": 200,
  "message": "获取成功",
  "overhead": 2345,
  "data": {
    "id": 1,
    "name": "bamboo"
  }
}

错误响应

{
  "context": "req_abc123",
  "output": "NOT_FOUND",
  "code": 40400,
  "message": "未找到",
  "error_message": "用户不存在",
  "overhead": 567
}

下一步

On this page