The highest tagged major version is v2.

core

package

v1.0.3 Latest Latest Go to latest Published: Apr 28, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/FangcunMount/iam

Links

Open Source Insights

Documentation ¶

Overview ¶

Package core 实现了一些核心功能，用于apimachinery

Index ¶

func WriteResponse(c *gin.Context, err error, data interface{})
type BaseHandler
- func NewBaseHandler() *BaseHandler
type ErrResponse
type Response

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func WriteResponse ¶

func WriteResponse(c *gin.Context, err error, data interface{})

WriteResponse 将错误或响应数据写入 HTTP 响应体它使用 errors.ParseCoder 将任何错误解析为 errors.Coder 如果 err 不为 nil，则将错误写入响应体如果 err 为 nil，则将响应数据写入响应体，格式为 {"code":0,"message":"success","data":{...}}

Types ¶

type BaseHandler ¶

type BaseHandler struct{}

BaseHandler 基础Handler结构提供通用的HTTP响应方法

func NewBaseHandler ¶

func NewBaseHandler() *BaseHandler

NewBaseHandler 创建基础Handler

func (*BaseHandler) BadRequestResponse ¶

func (h *BaseHandler) BadRequestResponse(c *gin.Context, message string, err error)

BadRequestResponse 400错误响应

func (*BaseHandler) BindJSON ¶

func (h *BaseHandler) BindJSON(c *gin.Context, obj interface{}) error

BindJSON 绑定JSON参数

func (*BaseHandler) BindQuery ¶

func (h *BaseHandler) BindQuery(c *gin.Context, obj interface{}) error

BindQuery 绑定查询参数

func (*BaseHandler) BindURI ¶

func (h *BaseHandler) BindURI(c *gin.Context, obj interface{}) error

BindURI URI参数绑定的别名（统一命名风格）

func (*BaseHandler) BindUri ¶

func (h *BaseHandler) BindUri(c *gin.Context, obj interface{}) error

BindUri 绑定URI参数

func (*BaseHandler) ConflictResponse ¶

func (h *BaseHandler) ConflictResponse(c *gin.Context, message string, err error)

ConflictResponse 409错误响应

func (*BaseHandler) Created ¶

func (h *BaseHandler) Created(c *gin.Context, data interface{})

Created 创建成功响应的简化别名。

func (*BaseHandler) CreatedResponse ¶

func (h *BaseHandler) CreatedResponse(c *gin.Context, data interface{})

CreatedResponse 成功创建响应。

func (*BaseHandler) Error ¶

func (h *BaseHandler) Error(c *gin.Context, err error)

Error 错误响应的简化别名

func (*BaseHandler) ErrorResponse ¶

func (h *BaseHandler) ErrorResponse(c *gin.Context, err error)

ErrorResponse 智能错误响应 - 根据错误类型自动选择合适的HTTP状态码和错误码

func (*BaseHandler) ErrorResponseWithCode ¶

func (h *BaseHandler) ErrorResponseWithCode(c *gin.Context, code int, format string, args ...interface{})

ErrorResponseWithCode 直接使用错误码的错误响应

func (*BaseHandler) ErrorWithCode ¶

func (h *BaseHandler) ErrorWithCode(c *gin.Context, code int, format string, args ...interface{})

ErrorWithCode 错误码响应的简化别名

func (*BaseHandler) ForbiddenResponse ¶

func (h *BaseHandler) ForbiddenResponse(c *gin.Context, message string)

ForbiddenResponse 403错误响应

func (*BaseHandler) GetPathParam ¶

func (h *BaseHandler) GetPathParam(c *gin.Context, key string) string

GetPathParam 获取路径参数

func (*BaseHandler) GetQueryParam ¶

func (h *BaseHandler) GetQueryParam(c *gin.Context, key string) string

GetQueryParam 获取查询参数

func (*BaseHandler) GetQueryParamInt ¶

func (h *BaseHandler) GetQueryParamInt(c *gin.Context, key string, defaultValue int) int

GetQueryParamInt 获取整数查询参数

func (*BaseHandler) GetTenantID ¶

func (h *BaseHandler) GetTenantID(c *gin.Context) string

GetTenantID 从上下文中获取租户ID

func (*BaseHandler) GetUserID ¶

func (h *BaseHandler) GetUserID(c *gin.Context) (string, bool)

GetUserID 从上下文中获取用户ID 返回用户ID和是否存在的标志

func (*BaseHandler) InternalErrorResponse ¶

func (h *BaseHandler) InternalErrorResponse(c *gin.Context, message string, err error)

InternalErrorResponse 500错误响应

func (*BaseHandler) NoContent ¶

func (h *BaseHandler) NoContent(c *gin.Context)

NoContent 写出 204 No Content 响应

func (*BaseHandler) NotFoundResponse ¶

func (h *BaseHandler) NotFoundResponse(c *gin.Context, message string, err error)

NotFoundResponse 404错误响应

func (*BaseHandler) Success ¶

func (h *BaseHandler) Success(c *gin.Context, data interface{})

Success 成功响应的简化别名

func (*BaseHandler) SuccessResponse ¶

func (h *BaseHandler) SuccessResponse(c *gin.Context, data interface{})

SuccessResponse 成功响应

func (*BaseHandler) SuccessResponseWithMessage ¶

func (h *BaseHandler) SuccessResponseWithMessage(c *gin.Context, message string, data interface{})

SuccessResponseWithMessage 带消息的成功响应

func (*BaseHandler) UnauthorizedResponse ¶

func (h *BaseHandler) UnauthorizedResponse(c *gin.Context, message string)

UnauthorizedResponse 401错误响应

func (*BaseHandler) ValidationErrorResponse ¶

func (h *BaseHandler) ValidationErrorResponse(c *gin.Context, field, message string)

ValidationErrorResponse 参数验证错误响应

type ErrResponse ¶

type ErrResponse struct {
	// Code 定义了业务错误代码
	Code int `json:"code"`

	// Message 包含此消息的详细信息
	// 此消息适合暴露给外部
	Message string `json:"message"`

	// Reference 返回参考文档，可能有助于解决此错误
	Reference string `json:"reference,omitempty"`
}

ErrResponse 定义了当发生错误时返回的消息如果 Reference 不存在，则省略 swagger:model

type Response ¶

type Response struct {
	// Code 业务状态码，0 表示成功
	Code int `json:"code"`

	// Message 响应消息
	Message string `json:"message"`

	// Data 响应数据
	Data interface{} `json:"data,omitempty"`

	// Reference 返回参考文档（错误时使用）
	Reference string `json:"reference,omitempty"`
}

Response 统一响应结构 swagger:model

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL