Add docs link to 400 responses and status (#21)

Author: man90es

handlers/Catchall.go

@@ -0,0 +1,9 @@
+package handlers
+
+import (
+	"net/http"
+)
+
+func Catchall(w http.ResponseWriter, r *http.Request) {
+	giveBadRequestResponse(w)
+}

handlers/GetAdventurer.go

@@ -17,7 +17,7 @@ func GetAdventurer(w http.ResponseWriter, r *http.Request) {
 	region, regionOk := validators.ValidateRegionQueryParam(r.URL.Query()["region"])
 
 	if !profileTargetOk || !regionOk {
-		w.WriteHeader(http.StatusBadRequest)
+		giveBadRequestResponse(w)
 		return
 	}
 

handlers/GetAdventurerSearch.go

@@ -21,7 +21,7 @@ func GetAdventurerSearch(w http.ResponseWriter, r *http.Request) {
 	searchType := validators.ValidateSearchTypeQueryParam(r.URL.Query()["searchType"])
 
 	if !queryOk || !regionOk {
-		w.WriteHeader(http.StatusBadRequest)
+		giveBadRequestResponse(w)
 		return
 	}
 

handlers/GetGuild.go

@@ -18,7 +18,7 @@ func GetGuild(w http.ResponseWriter, r *http.Request) {
 	region, regionOk := validators.ValidateRegionQueryParam(r.URL.Query()["region"])
 
 	if !nameOk || !regionOk {
-		w.WriteHeader(http.StatusBadRequest)
+		giveBadRequestResponse(w)
 		return
 	}
 

handlers/GetGuildSearch.go

@@ -20,7 +20,7 @@ func GetGuildSearch(w http.ResponseWriter, r *http.Request) {
 	region, regionOk := validators.ValidateRegionQueryParam(r.URL.Query()["region"])
 
 	if !nameOk || !regionOk {
-		w.WriteHeader(http.StatusBadRequest)
+		giveBadRequestResponse(w)
 		return
 	}
 

handlers/GetStatus.go

@@ -10,6 +10,7 @@ import (
 )
 
 var initTime = time.Now()
+var version = "1.8.4"
 
 func GetStatus(w http.ResponseWriter, r *http.Request) {
 	json.NewEncoder(w).Encode(map[string]interface{}{
@@ -26,8 +27,9 @@ func GetStatus(w http.ResponseWriter, r *http.Request) {
 				"maintenanceStatus": config.GetMaintenanceStatusTTL().Round(time.Minute).String(),
 			},
 		},
+		"docs":    docsLink,
 		"proxies": len(config.GetProxyList()),
 		"uptime":  time.Since(initTime).Round(time.Second).String(),
-		"version": "1.8.3",
+		"version": version,
 	})
 }

handlers/giveBadRequestResponse.go

@@ -0,0 +1,16 @@
+package handlers
+
+import (
+	"encoding/json"
+	"net/http"
+)
+
+const docsLink = "https://man90es.github.io/BDO-REST-API"
+
+func giveBadRequestResponse(w http.ResponseWriter) {
+	w.WriteHeader(http.StatusBadRequest)
+
+	json.NewEncoder(w).Encode(map[string]string{
+		"message": "Route or parameter is invalid. See documentation " + docsLink,
+	})
+}

httpServer/BuildServer.go

@@ -18,7 +18,7 @@ func BuildServer() *http.Server {
 		"/v1/adventurer/search": handlers.GetAdventurerSearch,
 		"/v1/guild":             handlers.GetGuild,
 		"/v1/guild/search":      handlers.GetGuildSearch,
-	})
+	}, handlers.Catchall)
 
 	if err != nil {
 		log.Fatal(err)

httpServer/registerHandlers.go

@@ -8,7 +8,7 @@ import (
 	"github.com/gorilla/mux"
 )
 
-func registerHandlers(handlerMap map[string]func(http.ResponseWriter, *http.Request)) (*mux.Router, error) {
+func registerHandlers(handlerMap map[string]func(http.ResponseWriter, *http.Request), catchall func(http.ResponseWriter, *http.Request)) (*mux.Router, error) {
 	router := mux.NewRouter()
 
 	for route, handler := range handlerMap {
@@ -18,6 +18,7 @@ func registerHandlers(handlerMap map[string]func(http.ResponseWriter, *http.Requ
 			),
 		).Methods("GET")
 	}
+	router.PathPrefix("/").HandlerFunc(catchall)
 
 	return router, nil
 }