httpresp

package

v0.0.0-...-a7ad5ca Latest Latest Go to latest Published: Sep 30, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Details

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

Repository

github.com/NSObjects/echo-admin

Links

Open Source Insights

Documentation ¶

Overview ¶

Package httpresp renders framework-specific HTTP error responses.

Index ¶

func APIError(c *echo.Context, err error) error
func Created(c *echo.Context, data interface{}) error
func DeletedIDs(c *echo.Context, ids []int64) error
func OK(c *echo.Context, data interface{}) error
func Paginated(c *echo.Context, data interface{}, page, pageSize, total int) error
func RequestID(c *echo.Context) string
type ErrorResponse
type ListResponse
type PageMeta
type Response

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func APIError ¶

func APIError(c *echo.Context, err error) error

APIError renders a project error as a JSON HTTP response.

func Created ¶

func Created(c *echo.Context, data interface{}) error

Created renders a successful creation response envelope.

func DeletedIDs ¶

func DeletedIDs(c *echo.Context, ids []int64) error

DeletedIDs renders a successful batch-delete response echoing the IDs.

func OK ¶

func OK(c *echo.Context, data interface{}) error

OK renders a successful response envelope.

func Paginated ¶

func Paginated(c *echo.Context, data interface{}, page, pageSize, total int) error

Paginated renders a successful paginated list response envelope.

func RequestID ¶

func RequestID(c *echo.Context) string

RequestID returns the request ID used in HTTP error responses.

Types ¶

type ErrorResponse ¶

type ErrorResponse struct {
	Code      int    `json:"code"`
	Message   string `json:"message"`
	RequestID string `json:"request_id"`
	Timestamp int64  `json:"timestamp"`
}

ErrorResponse is the standard JSON error response for HTTP adapters.

type ListResponse ¶

type ListResponse struct {
	Code      int         `json:"code"`
	Message   string      `json:"message"`
	Data      interface{} `json:"data"`
	Page      PageMeta    `json:"page"`
	RequestID string      `json:"request_id"`
	Timestamp int64       `json:"timestamp"`
}

ListResponse is the standard JSON list response for HTTP adapters.

type PageMeta ¶

type PageMeta struct {
	Page     int  `json:"page"`
	PageSize int  `json:"page_size"`
	Total    int  `json:"total"`
	HasNext  bool `json:"has_next"`
}

PageMeta describes paginated list response metadata.

type Response ¶

type Response struct {
	Code      int         `json:"code"`
	Message   string      `json:"message"`
	Data      interface{} `json:"data,omitempty"`
	RequestID string      `json:"request_id"`
	Timestamp int64       `json:"timestamp"`
}

Response is the standard JSON success response for HTTP adapters.

Source Files ¶

View all Source files

response.go

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