README
¶
HTTP
This is a simple HTTP server powered by Fiber. With some customization to enchance the development experience and performance.
Documentation
¶
Index ¶
Constants ¶
View Source
const ( ErrorMetadataCode = "code" ErrorMetadataUserMessage = "message" )
Variables ¶
This section is empty.
Functions ¶
func JSONResponse ¶ added in v0.0.2
JSONResponse is the function that will be used to send a JSON response. For custome message, you can use gerr.Metadata to store the message. Raw error will show on your log message. Example:
err := gerr.New("Connection Lost")
return gerr.NewWithMetadata(err, http.Metadata(http.StatusBadRequest, "Internal Server Error"))
JSON Response:
{
"success": false,
"message": "Internal Server Error",
}
But if you want to show the raw error message to the user, you can leave ErrorMetadataUserMessage empty. Example:
err := gerr.New("Connection Lost")
return gerr.NewWithMetadata(err, http.Metadata(http.StatusBadRequest, ""))
JSON Response:
{
"success": false,
"message": "Connection Lost",
}
Types ¶
type BaseResponse ¶
type BaseResponse struct {
Status int `json:"status"`
Message *string `json:"message,omitempty"`
Error string `json:"error"`
}
We can define a base response struct that will be used by all other response structs. This will help us to maintain a consistent response format across the application. This will also help us to easily change the response format in the future. Example:
type TestResponse struct {
*BaseResponse `json:"response,omitempty"`
Data interface{} `json:"data"`
}
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.