maintenance

package module
Version: v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 1, 2020 License: MIT Imports: 2 Imported by: 0

README

CircleCI

go-echo-maintenance

Middleware for echo framework to make all requests respond according to a handler function based on the presence/absence of a file specified. It is built with go version go1.13.1 darwin/amd64

Installing

*go get
    go get -u "github.com/rakutentech/go-echo-maintenance"

Usage

package main

import (
    "net/http"

    maintenance "github.com/rakutentech/go-echo-maintenance"
    "github.com/labstack/echo"
)

func customHandlerFunc(c echo.Context) error {
    return c.HTML(http.StatusNotFound, `<h1 style="color:red;">Request is intercepted by maintenance middleware!</h1>`)
}

func main() {
    e := echo.New()
    middleware := maintenance.NewMaintMiddleware("/path/to/maint/file", customHandlerFunc)

    e.Use(middleware.CheckMaintenance)
    e.GET("/", func(c echo.Context) error {
        return c.String(http.StatusOK, "Hello, World!")
    })

    // Start server
    e.Logger.Fatal(e.Start(":1323"))
}

Create maintenance file

touch /path/to/maint/file

The middleware will intercept requests to api domain and respond according to the custom handler specified by user.

Remove maintenance file

rm /path/to/maint/file

The middleware will no longer intercept requests to api domain.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Middleware

type Middleware struct {
	// contains filtered or unexported fields
}

Middleware struct

func NewMaintMiddleware

func NewMaintMiddleware(filePath string, customHandler echo.HandlerFunc) *Middleware

NewMaintMiddleware - Creates a *Middleware instance with maint file path and custom response struct

func (*Middleware) CheckMaintenance

func (middleware *Middleware) CheckMaintenance(next echo.HandlerFunc) echo.HandlerFunc

CheckMaintenance - middleware to check if maintenance mode is on

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL