Add api package function comments

Author: Steven Ayers

api/handlers.go

@@ -23,7 +23,9 @@ type (
 	}
 )
 
-func Search(w http.ResponseWriter, r *http.Request) {
+// Handler for /search endpoint. Initiates a database connection, tries to find the url in the database with the
+// required depth, and if it doesn't exist, initiate a crawl.
+func SearchHandler(w http.ResponseWriter, r *http.Request) {
 	w.Header().Set("Content-Type", "application/json; charset=UTF-8")
 	vars := mux.Vars(r)
 	depth, err := strconv.Atoi(vars["depth"])

api/routes.go

@@ -23,14 +23,15 @@ var DefinedRoutes = Routes{
 		"Initiate",
 		"GET",
 		"/search",
-		Search,
+		SearchHandler,
 		[]string{
 			"url", "{url}",
 			"depth", "{depth}",
 		},
 	},
 }
 
+// Initiates a mux router object with custom HTTP Response logger.
 func NewRouter() *mux.Router {
 	router := mux.NewRouter().StrictSlash(true)
 	for _, route := range DefinedRoutes {