Return 500 Status Code or Internal Server Error in HTTP response in Go (Golang)

Overview

net/http package of golang provides the status code constants which could be used to return different status codes- https://golang.org/src/net/http/status.go

The same can also be used to return the 500 (StatusInternalServerError) HTTP status code.  The HTTP 500 status code is defined by the below constant

http.StatusInternalServerError

In this article, we will also see how to return a JSON body along with the 500(StatusInternalServerError) Status Code

Program

Below is the program for the same

package main

import (
	"encoding/json"
	"log"
	"net/http"
)

func main() {
	handler := http.HandlerFunc(handleRequest)
	http.Handle("/example", handler)
	http.ListenAndServe(":8080", nil)
}

func handleRequest(w http.ResponseWriter, r *http.Request) {
	w.WriteHeader(http.StatusInternalServerError)
	w.Header().Set("Content-Type", "application/json")
	resp := make(map[string]string)
	resp["message"] = "Some Error Occurred"
	jsonResp, err := json.Marshal(resp)
	if err != nil {
		log.Fatalf("Error happened in JSON marshal. Err: %s", err)
	}
	w.Write(jsonResp)
	return
}

Here we are using the WriteHeader function to specify the 500 http status code and uses the Write function to also return the response bodyThe above code returns the below JSON request body back in response

{"message":"Some Error Occurred"}

Run the above program. It will start a server on 8080 port on your local machine. Now make the below curl call to the server

curl -v -X POST http://localhost:8080/example

Below will be the output

* Connected to localhost (::1) port 8080 (#0)
> POST /example HTTP/1.1
> Host: localhost:8080
> User-Agent: curl/7.54.0
> Accept: */*
> 
< HTTP/1.1 500 Internal Server Error
< Date: Sat, 10 Jul 2021 10:49:52 GMT
< Content-Length: 33
< Content-Type: text/plain; charset=utf-8
< 
* Connection #0 to host localhost left intact
{"message":"Some Error Occurred"}

As you can see from the output, it will correctly return the 500 status code along with the body.

You can also directly pass 500 to the WriteHeader function to send the 500 response.

w.WriteHeader(500)

This also works correctly. Try it out.

Also, check out our Golang advance tutorial Series - Golang Advance Tutorial