CODEWITHSUNDEEP
mongodbrestgogo-gin
Кафка
Кафка

Reputation: 517

Adding information to Golang Gin HTTP error responses

I am trying to return a custom error response when an HTTP 500 Internal Error is encountered. If I use c.JSON(http.StatusInternalServerError, CustomError{}) when a database write error occurs, Gin ignores my CustomError struct and substitutes a default "500 server Error" message.

How can I add information to the default response or return a custom response while still using the HTTP 500 Internal Server error code?

This is what I am trying to accomplish. Notifying users of a duplicate entry in the Mongo database. Gin ignores my DBErrorResponse struct and just returns the default 500 error json response.

_, err := handler.collection.InsertOne(handler.ctx, data)
   if err != nil {
       if mongo.IsDuplicateKeyError(err) {
          dbErr := err.(mongo.WriteException)
           c.JSON(
               http.StatusInternalServerError,
               models.DBErrorResponse{
                   Type: "Write Exception",
                   Code: dbErr.WriteErrors[0].Code,
                   Err:  "similar record exists",
               })

           return
      }

Upvotes: 1

Views: 759

Answers (1)

Alexsen
Alexsen

Reputation: 176

If the error is caused by a user providing a duplicate key, it's not an internal server error. You might want to use something like BadRequest(400), which suits duplicate value far more, if provided by the client. Thus, you should be able to return a custom error message with StatusCode 400.

Additionally, as far as I know, InternalServerError(500) is not designed to provide a 'server-side' problem feedback to the client, since, well, it's not public information. Although I'm not certainly sure if that's so and if is, why.

UPD: As Gavin mentioned, httpCode 409 is far better choice, here is the doc:

HTTP 409 error status: The HTTP 409 status code (Conflict) indicates that the request could not be processed because of conflict in the request, such as the requested resource is not in the expected state, or the result of processing the request would create a conflict within the resource.

Upvotes: 2

Related Questions