gores

Go package that handles HTML, JSON, XML and etc. responses

Programming language: Go

License: Apache License 2.0

Tags: Web Frameworks     Libraries For Creating HTTP Middlewares    

Latest version: v1.2.2

README

gores

http response utility library for Go

this package is very small and lightweight, useful for RESTful APIs.

installation

go get github.com/alioygur/gores

usage

package main

import (
    "log"
    "net/http"

    "github.com/alioygur/gores"
)

type User struct {
    Name  string
    Email string
    Age   int
}

func main() {
    // Plain text response
    http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
        gores.String(w, http.StatusOK, "Hello World")
    })

    // HTML response
    http.HandleFunc("/html", func(w http.ResponseWriter, r *http.Request) {
        gores.HTML(w, http.StatusOK, "<h1>Hello World</h1>")
    })

    // JSON response
    http.HandleFunc("/json", func(w http.ResponseWriter, r *http.Request) {
        user := User{Name: "Ali", Email: "[email protected]", Age: 28}
        gores.JSON(w, http.StatusOK, user)
    })

    // File response
    http.HandleFunc("/file", func(w http.ResponseWriter, r *http.Request) {
        err := gores.File(w, r, "./path/to/file.html")

        if err != nil {
            log.Println(err.Error())
        }
    })

    // Download file
    http.HandleFunc("/download-file", func(w http.ResponseWriter, r *http.Request) {
        err := gores.Download(w, r, "./path/to/file.pdf", "example.pdf")

        if err != nil {
            log.Println(err.Error())
        }
    })

    // No content
    http.HandleFunc("/no-content", func(w http.ResponseWriter, r *http.Request) {
        gores.NoContent(w)
    })

    // Error response
    http.HandleFunc("/error", func(w http.ResponseWriter, r *http.Request) {
        gores.Error(w, http.StatusInternalServerError, http.StatusText(http.StatusInternalServerError))
    })

    err := http.ListenAndServe(":8000", nil)
    if err != nil {
        log.Fatal("ListenAndServe: ", err)
    }
}

for more documentation godoc

Contribute

Use issues for everything

• Report problems
• Discuss before sending a pull request
• Suggest new features/recipes
• Improve/fix documentation

Thanks & Authors

I use code/got inspiration from these excellent libraries:

• labstack/echo micro web framework