contract — API 快速参考

本页列出 github.com/spcent/plumego/contract 导出的每个公开符号。需要边界说明时请读 Contract Primer。

import "github.com/spcent/plumego/contract"

响应助手

func WriteResponse(w http.ResponseWriter, r *http.Request, status int, data any, meta any) error

写入 JSON 成功响应。data 放在 "data" 键；meta 非 nil 时放在 "meta" 键。自动注入 request_id。

报文格式：

{
  "data": { /* data */ },
  "meta": { /* meta，nil 时省略 */ },
  "request_id": "abc-123"
}

func WriteError(w http.ResponseWriter, r *http.Request, err *APIError) error

写入 JSON 错误响应。HTTP 状态码来自 err.Status。

func NewErrorBuilder() *ErrorBuilder

方法	签名	作用
`Type`	`(et ErrorType) *ErrorBuilder`	从目录自动设置类型、code、HTTP 状态、category
`Message`	`(msg string) *ErrorBuilder`	覆盖人类可读错误消息
`Detail`	`(key, value string) *ErrorBuilder`	向 `details` map 添加键值对
`Build`	`() *APIError`	返回完成的 `*APIError`

func RequestIDFromContext(ctx context.Context) string

func RequestContextFromContext(ctx context.Context) RequestContext

type RequestContext struct {
    Params       map[string]string
    RoutePattern string
    RouteName    string
}