dto

package
v0.1.13 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 15, 2026 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DataListResp added in v0.1.5

type DataListResp struct {
	Total int         `json:"total"` // total number of matching records; must not be omitted
	List  interface{} `json:"list"`  // slice of result items; must not be omitted
}

DataListResp is the standard paginated list response envelope. Both Total and List must not be omitted even when zero/nil so that the frontend can always rely on their presence.

type LoginUser

type LoginUser struct {
	Token     string   `json:"token,omitempty"`     // stored token used for inter-service REST calls; not included when generating a new token
	TokenType string   `json:"tokenType,omitempty"` // token purpose: "access" or "refresh"
	UserId    uint64   `json:"userId"`
	Username  string   `json:"username"`
	ProductId uint64   `json:"productId"`
	Roles     []string `json:"roles"`
}

LoginUser holds the claims embedded inside a JWT token for an authenticated user. Fields such as UserId, Username, ProductId, and Roles must not use omitempty so that zero values are always serialised.

type PageParameter added in v0.1.6

type PageParameter struct {
	Page      int    `json:"page"`  // current page number (1-based); must not be omitted
	Limit     int    `json:"limit"` // number of records per page; must not be omitted
	Sort      string `json:"sort,omitempty"`
	Direction string `json:"direction,omitempty" validate:"omitempty,oneofci=ASC DESC"` // sort direction: ASC or DESC
	Charset   string `json:"charset,omitempty"`
}

PageParameter holds pagination and sorting parameters for list queries. Page and Limit must always be present (non-omitempty) so that the frontend can rely on their presence in the JSON payload.

type ResourceResp added in v0.1.11

type ResourceResp struct {
	Id     int    `json:"id"`
	Name   string `json:"name,omitempty"`
	Status int    `json:"status,omitempty"`
}

type ResponseMessage

type ResponseMessage struct {
	Code    int    `json:"code"`              // 0: success; others: failed
	Message string `json:"message,omitempty"` // omit in success response
	Data    any    `json:"data,omitempty"`    // omit in failed response
}

ResponseMessage is the standard response envelope returned by all API endpoints. Code 0 indicates success; any other value indicates failure.

Jump to

Keyboard shortcuts

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