Documentation
¶
Overview ¶
Package ginhttp 将 api handler 适配为 Gin HTTP 路由。
该层负责绑定请求、安装认证主体、映射状态码和写出统一响应。
Index ¶
- func PrincipalMiddleware(resolve PrincipalResolver) gin.HandlerFunc
- func RegisterApprovalRoutes(group gin.IRoutes, handler *api.ApprovalHandler)
- func RegisterPlatformRoutes(group gin.IRoutes, handler *api.PlatformHandler)
- func RegisterTraceRoutes(group gin.IRoutes, handler *api.TraceHandler)
- func RegisterWorkerRoutes(group gin.IRoutes, handler *api.WorkerPullHandler)
- func RegisterWorkflowRoutes(group gin.IRoutes, handler *api.WorkflowHandler)
- func WorkerTokenMiddleware(expectedToken string) gin.HandlerFunc
- type ApprovalController
- func (c *ApprovalController) AllRequests(ctx *gin.Context)
- func (c *ApprovalController) ApplyWorkspaceJoin(ctx *gin.Context)
- func (c *ApprovalController) Detail(ctx *gin.Context)
- func (c *ApprovalController) Judge(ctx *gin.Context)
- func (c *ApprovalController) MyRequests(ctx *gin.Context)
- func (c *ApprovalController) PendingForMe(ctx *gin.Context)
- func (c *ApprovalController) Submit(ctx *gin.Context)
- type PlatformController
- func (c *PlatformController) AddMember(ctx *gin.Context)
- func (c *PlatformController) ChangePassword(ctx *gin.Context)
- func (c *PlatformController) CreatePermission(ctx *gin.Context)
- func (c *PlatformController) CreateRole(ctx *gin.Context)
- func (c *PlatformController) CreateUser(ctx *gin.Context)
- func (c *PlatformController) CreateWorkspace(ctx *gin.Context)
- func (c *PlatformController) DeleteRole(ctx *gin.Context)
- func (c *PlatformController) DeleteWorkspaceEnvironment(ctx *gin.Context)
- func (c *PlatformController) ListAuditLogs(ctx *gin.Context)
- func (c *PlatformController) ListMembers(ctx *gin.Context)
- func (c *PlatformController) ListPermissions(ctx *gin.Context)
- func (c *PlatformController) ListRoles(ctx *gin.Context)
- func (c *PlatformController) ListUsers(ctx *gin.Context)
- func (c *PlatformController) ListWorkspaceEnvironments(ctx *gin.Context)
- func (c *PlatformController) ListWorkspaces(ctx *gin.Context)
- func (c *PlatformController) RemoveMember(ctx *gin.Context)
- func (c *PlatformController) ResetUserPassword(ctx *gin.Context)
- func (c *PlatformController) SaveWorkspaceEnvironment(ctx *gin.Context)
- func (c *PlatformController) SetUserDisabled(ctx *gin.Context)
- func (c *PlatformController) UpdateMemberRoles(ctx *gin.Context)
- func (c *PlatformController) UpdatePermission(ctx *gin.Context)
- func (c *PlatformController) UpdateRole(ctx *gin.Context)
- func (c *PlatformController) UpdateWorkspace(ctx *gin.Context)
- type PrincipalResolver
- type TraceController
- type WorkerPullController
- type WorkflowController
- func (c *WorkflowController) Clone(ctx *gin.Context)
- func (c *WorkflowController) CompareVersions(ctx *gin.Context)
- func (c *WorkflowController) Delete(ctx *gin.Context)
- func (c *WorkflowController) Disable(ctx *gin.Context)
- func (c *WorkflowController) ExecutePublished(ctx *gin.Context)
- func (c *WorkflowController) GetPublished(ctx *gin.Context)
- func (c *WorkflowController) GetVersion(ctx *gin.Context)
- func (c *WorkflowController) List(ctx *gin.Context)
- func (c *WorkflowController) Publish(ctx *gin.Context)
- func (c *WorkflowController) Rollback(ctx *gin.Context)
- func (c *WorkflowController) Save(ctx *gin.Context)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PrincipalMiddleware ¶
func PrincipalMiddleware(resolve PrincipalResolver) gin.HandlerFunc
PrincipalMiddleware 将解析出的 Principal 写入请求 context。
func RegisterApprovalRoutes ¶
func RegisterApprovalRoutes(group gin.IRoutes, handler *api.ApprovalHandler)
RegisterApprovalRoutes 注册审批相关路由。
func RegisterPlatformRoutes ¶
func RegisterPlatformRoutes(group gin.IRoutes, handler *api.PlatformHandler)
RegisterPlatformRoutes 注册平台管理路由。
func RegisterTraceRoutes ¶
func RegisterTraceRoutes(group gin.IRoutes, handler *api.TraceHandler)
RegisterTraceRoutes 注册 trace 查询路由。
func RegisterWorkerRoutes ¶
func RegisterWorkerRoutes(group gin.IRoutes, handler *api.WorkerPullHandler)
RegisterWorkerRoutes 注册业务 worker 拉取 workflow 的路由。
func RegisterWorkflowRoutes ¶
func RegisterWorkflowRoutes(group gin.IRoutes, handler *api.WorkflowHandler)
RegisterWorkflowRoutes 注册 workflow 管理和发布执行路由。
func WorkerTokenMiddleware ¶
func WorkerTokenMiddleware(expectedToken string) gin.HandlerFunc
WorkerTokenMiddleware 校验业务 worker 调用控制面拉取接口时携带的 token。
Types ¶
type ApprovalController ¶
type ApprovalController struct {
// contains filtered or unexported fields
}
ApprovalController 将审批 API handler 适配为 Gin controller。
func NewApprovalController ¶
func NewApprovalController(handler *api.ApprovalHandler) *ApprovalController
NewApprovalController 创建审批 Gin controller。
func (*ApprovalController) AllRequests ¶
func (c *ApprovalController) AllRequests(ctx *gin.Context)
func (*ApprovalController) ApplyWorkspaceJoin ¶
func (c *ApprovalController) ApplyWorkspaceJoin(ctx *gin.Context)
func (*ApprovalController) Detail ¶
func (c *ApprovalController) Detail(ctx *gin.Context)
func (*ApprovalController) Judge ¶
func (c *ApprovalController) Judge(ctx *gin.Context)
func (*ApprovalController) MyRequests ¶
func (c *ApprovalController) MyRequests(ctx *gin.Context)
func (*ApprovalController) PendingForMe ¶
func (c *ApprovalController) PendingForMe(ctx *gin.Context)
func (*ApprovalController) Submit ¶
func (c *ApprovalController) Submit(ctx *gin.Context)
type PlatformController ¶
type PlatformController struct {
// contains filtered or unexported fields
}
PlatformController 将平台管理 API handler 适配为 Gin controller。
func NewPlatformController ¶
func NewPlatformController(handler *api.PlatformHandler) *PlatformController
NewPlatformController 创建平台管理 Gin controller。
func (*PlatformController) AddMember ¶
func (c *PlatformController) AddMember(ctx *gin.Context)
func (*PlatformController) ChangePassword ¶
func (c *PlatformController) ChangePassword(ctx *gin.Context)
func (*PlatformController) CreatePermission ¶
func (c *PlatformController) CreatePermission(ctx *gin.Context)
func (*PlatformController) CreateRole ¶
func (c *PlatformController) CreateRole(ctx *gin.Context)
func (*PlatformController) CreateUser ¶
func (c *PlatformController) CreateUser(ctx *gin.Context)
func (*PlatformController) CreateWorkspace ¶
func (c *PlatformController) CreateWorkspace(ctx *gin.Context)
func (*PlatformController) DeleteRole ¶
func (c *PlatformController) DeleteRole(ctx *gin.Context)
func (*PlatformController) DeleteWorkspaceEnvironment ¶
func (c *PlatformController) DeleteWorkspaceEnvironment(ctx *gin.Context)
func (*PlatformController) ListAuditLogs ¶
func (c *PlatformController) ListAuditLogs(ctx *gin.Context)
func (*PlatformController) ListMembers ¶
func (c *PlatformController) ListMembers(ctx *gin.Context)
func (*PlatformController) ListPermissions ¶
func (c *PlatformController) ListPermissions(ctx *gin.Context)
func (*PlatformController) ListRoles ¶
func (c *PlatformController) ListRoles(ctx *gin.Context)
func (*PlatformController) ListUsers ¶
func (c *PlatformController) ListUsers(ctx *gin.Context)
func (*PlatformController) ListWorkspaceEnvironments ¶
func (c *PlatformController) ListWorkspaceEnvironments(ctx *gin.Context)
func (*PlatformController) ListWorkspaces ¶
func (c *PlatformController) ListWorkspaces(ctx *gin.Context)
func (*PlatformController) RemoveMember ¶
func (c *PlatformController) RemoveMember(ctx *gin.Context)
func (*PlatformController) ResetUserPassword ¶
func (c *PlatformController) ResetUserPassword(ctx *gin.Context)
func (*PlatformController) SaveWorkspaceEnvironment ¶
func (c *PlatformController) SaveWorkspaceEnvironment(ctx *gin.Context)
func (*PlatformController) SetUserDisabled ¶
func (c *PlatformController) SetUserDisabled(ctx *gin.Context)
func (*PlatformController) UpdateMemberRoles ¶
func (c *PlatformController) UpdateMemberRoles(ctx *gin.Context)
func (*PlatformController) UpdatePermission ¶
func (c *PlatformController) UpdatePermission(ctx *gin.Context)
func (*PlatformController) UpdateRole ¶
func (c *PlatformController) UpdateRole(ctx *gin.Context)
func (*PlatformController) UpdateWorkspace ¶
func (c *PlatformController) UpdateWorkspace(ctx *gin.Context)
type PrincipalResolver ¶
PrincipalResolver 从 Gin 请求中解析认证主体。
type TraceController ¶
type TraceController struct {
// contains filtered or unexported fields
}
TraceController 将 trace API handler 适配为 Gin controller。
func NewTraceController ¶
func NewTraceController(handler *api.TraceHandler) *TraceController
NewTraceController 创建 trace Gin controller。
func (*TraceController) GetEvents ¶
func (c *TraceController) GetEvents(ctx *gin.Context)
func (*TraceController) Search ¶
func (c *TraceController) Search(ctx *gin.Context)
type WorkerPullController ¶
type WorkerPullController struct {
// contains filtered or unexported fields
}
WorkerPullController 将 worker pull API handler 适配为 Gin controller。
func NewWorkerPullController ¶
func NewWorkerPullController(handler *api.WorkerPullHandler) *WorkerPullController
NewWorkerPullController 创建 worker pull Gin controller。
func (*WorkerPullController) Bootstrap ¶
func (c *WorkerPullController) Bootstrap(ctx *gin.Context)
func (*WorkerPullController) GetPublished ¶
func (c *WorkerPullController) GetPublished(ctx *gin.Context)
type WorkflowController ¶
type WorkflowController struct {
// contains filtered or unexported fields
}
WorkflowController 将 workflow API handler 适配为 Gin controller。
func NewWorkflowController ¶
func NewWorkflowController(handler *api.WorkflowHandler) *WorkflowController
NewWorkflowController 创建 workflow Gin controller。
func (*WorkflowController) Clone ¶
func (c *WorkflowController) Clone(ctx *gin.Context)
func (*WorkflowController) CompareVersions ¶
func (c *WorkflowController) CompareVersions(ctx *gin.Context)
func (*WorkflowController) Delete ¶
func (c *WorkflowController) Delete(ctx *gin.Context)
func (*WorkflowController) Disable ¶
func (c *WorkflowController) Disable(ctx *gin.Context)
func (*WorkflowController) ExecutePublished ¶
func (c *WorkflowController) ExecutePublished(ctx *gin.Context)
func (*WorkflowController) GetPublished ¶
func (c *WorkflowController) GetPublished(ctx *gin.Context)
func (*WorkflowController) GetVersion ¶
func (c *WorkflowController) GetVersion(ctx *gin.Context)
func (*WorkflowController) List ¶
func (c *WorkflowController) List(ctx *gin.Context)
func (*WorkflowController) Publish ¶
func (c *WorkflowController) Publish(ctx *gin.Context)
func (*WorkflowController) Rollback ¶
func (c *WorkflowController) Rollback(ctx *gin.Context)
func (*WorkflowController) Save ¶
func (c *WorkflowController) Save(ctx *gin.Context)
Source Files
Click to show internal directories.
Click to hide internal directories.