middleware

README

Middleware

Iris has it's build'n small middleware(s) here

Structure

*All Iris build'n middleware(s) belong here, to this folder 'iris/middleware' ** middleware is also the package name.

Each middleware is written to file(s) but no to different folder(s), that's means that iris/middleware doesn't have any children folder.

All middleware(s) have share code via the same package name so be carefuly when you write a midleware, we need sharing between them but no conficts.

---

How to write

Simple, Import iris and use it to the middleware

import (
	iris "github.com/kataras/iris"
)

Each middleware must export only one Function which returns an object which implements the iris.Handler (func Serve(ctx *iris.Context){})

---

Why? Three reasons

1. Easier import path for all middleware(s) (e.g github.com/kataras/iris/middleware vs github.com/kataras/iris/middleware/gzip github.com/kataras/iris/middleware/othermiddleware and so on)
2. Minimize the code that Iris middleware(s) will re-uses
3. Protect ourself from import circles between middleware(s).

How to use a middleware

package main

import (
	"github.com/kataras/iris"
	"github.com/kataras/iris/middleware"
)

type Page struct {
	Title string
}

func main() {
	iris.Templates("./_examples/compression_gzip/templates/*.html")
	// here is How to use a middleware
	iris.Use(middleware.Gzip(middleware.DefaultCompression))
	//
	iris.Get("/public/*static", iris.Static("./_examples/compression_gzip/static/", "/public/"))

	iris.Get("/", func(c *iris.Context) {
		c.RenderFile("index.html", Page{"My Index Title"})
	})

	iris.Listen(":8080")
}

Documentation

Overview

Copyright (c) 2016, Gerasimos Maropoulos All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JULIEN SCHMIDT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Copyright (c) 2016, Gerasimos Maropoulos All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JULIEN SCHMIDT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Index

• Constants
• func Gzip(compLevel int) *gzipMiddleware
• func Recovery(out ...io.Writer) iris.Handler

Constants

const (

	// check https://golang.org/src/compress/gzip/gzip.go and compress/flate package
	// for the values of these
	BestCompression    = gzip.BestCompression
	BestSpeed          = gzip.BestSpeed
	DefaultCompression = gzip.DefaultCompression
	NoCompression      = gzip.NoCompression
)

Functions

func Gzip

func Gzip(compLevel int) *gzipMiddleware

Gzip creates the middleware and returns it, for direct Use parameter compLevel value between BestSpeed and BestCompression inclusive. check https://golang.org/src/compress/gzip/gzip.go

func Recovery

func Recovery(out ...io.Writer) iris.Handler

Recovery restores the server on internal server errors (panics) receives an optional writer, the default is the os.Stderr if no out writer given