Routing in Go using Gorilla Mux

Published on January 24, 2020 59 sec read

HIRE US 🖐
We're available to do freelance project. Take a look at our services!

The net/http package has a lot of functionalities. The gorilla/mux comes with more routing features. In this article, we’re going to use gorilla mux for routing in Go. Let’s start:

Table of Contents

  1. Install Gorilla Mux Package
  2. Features of Gorilla Mux
  3. A Complete Example

Install Gorilla Mux Package

We can install gorilla/mux using go get  command:

go get -u github.com/gorilla/mux

Features of Gorilla Mux

I’m going to share some features of the Gorilla Mux package.

The routing syntax:

r := mux.NewRouter()

Restrict the request: We’re able to restrict to specific domain/subdomain:

r.HandleFunc("/posts/{slug}", BookHandler).Host("example.com")

Prefixes & Subrouters: We can set prefix and sub router like this:

bookrouter := r.PathPrefix("/posts").Subrouter()
bookrouter.HandleFunc("/", AllPosts)
bookrouter.HandleFunc("/{slug}", GetSinglePost)

HTTP methods: We can set specific method to routes:

r.HandleFunc("/posts/{slug}", CreatePost).Methods("POST")
r.HandleFunc("/posts/{slug}", ReadPost).Methods("GET")
r.HandleFunc("/posts/{slug}", UpdatePost).Methods("PUT")
r.HandleFunc("/posts/{slug}", DeletePost).Methods("DELETE")

Schemes: We’re able to set HTTP/HTTPS protocol restriction in route:

r.HandleFunc("/route1", HandlerInsecure).Schemes("http")
r.HandleFunc("/route2", HandlerSecure).Schemes("https")

A Complete Example

Let’s see a full example routing using gorilla mux:

package main

import (
    "fmt"
    "net/http"
    "github.com/gorilla/mux"
)

func index(w http.ResponseWriter, req *http.Request)  {
    fmt.Fprintf(w, "Welcome to MyNotePaper!")
}

func posts(w http.ResponseWriter, req *http.Request)  {
    vars := mux.Vars(req)
    post_id := vars["id"]

    fmt.Fprintf(w, "The requested post ID: %s\n", post_id)
}

func main() {
    r := mux.NewRouter()

    // routes
    r.HandleFunc("/", index)
    r.HandleFunc("/posts/{id}", posts)

    // listen port 80
    http.ListenAndServe(":80", r)
}

I hope this article will help you. 🙂

Author

Hey, I'm Md Obydullah. I build open-source projects and write on Laravel, Linux server, modern JavaScript and more on web development.

Follow

Leave a Reply

Your email address will not be published. Required fields are marked *