Documentation
¶
Index ¶
- Constants
- func ErrorMessage(code string) string
- func WriteApiJsonResponse(w http.ResponseWriter, result interface{}, statusCode int, errCode string, ...)
- func WriteApiJsonResponseStructured(w http.ResponseWriter, apiResponse *ApiResponse, statusCode int)
- func WriteJsonResp(w http.ResponseWriter, err error, respBody interface{}, status int)
- func WriteOctetStreamResp(w http.ResponseWriter, r *http.Request, byteArr []byte, defaultFilename string)
- type ApiResponse
- type ErrorResponse
- type Response
Constants ¶
View Source
const ( UnAuthenticated = "E100" UnAuthorized = "E101" BadRequest = "E102" InternalServerError = "E103" ResourceNotFound = "E104" UnknownError = "E105" CONTENT_DISPOSITION = "Content-Disposition" CONTENT_TYPE = "Content-Type" CONTENT_LENGTH = "Content-Length" APPLICATION_JSON = "application/json" )
Variables ¶
This section is empty.
Functions ¶
func ErrorMessage ¶ added in v0.4.24
func WriteApiJsonResponse ¶ added in v0.4.24
func WriteApiJsonResponse(w http.ResponseWriter, result interface{}, statusCode int, errCode string, errorMessage string)
func WriteApiJsonResponseStructured ¶ added in v0.4.24
func WriteApiJsonResponseStructured(w http.ResponseWriter, apiResponse *ApiResponse, statusCode int)
func WriteJsonResp ¶
func WriteJsonResp(w http.ResponseWriter, err error, respBody interface{}, status int)
use of writeJsonRespStructured is preferable. it api exists due to historical reason err.message is used as internal message for ApiError object in resp
func WriteOctetStreamResp ¶ added in v0.6.23
Types ¶
type ApiResponse ¶ added in v0.4.24
type ApiResponse struct { Success bool `json:"success,notnull" validate:"required"` Error *ErrorResponse `json:"error,omitempty"` Result interface{} `json:"result,omitempty"` }
type ErrorResponse ¶ added in v0.4.24
Click to show internal directories.
Click to hide internal directories.