The fastest backend web framework for Go.
Easy to learn, while it's highly customizable.
Ideally suited for both experienced and novice Developers.

Quick Look

package main

import "github.com/kataras/iris"

func main() {
	iris.Favicon("./favicon.ico")

	iris.Get("/", func(ctx *iris.Context) {
		ctx.Render("index.html")
	})

	iris.Get("/login", func(ctx *iris.Context) {
		ctx.Render("login.html", iris.Map{"Title": "Login Page"})
	})

	iris.Post("/login", func(ctx *iris.Context) {
		secret := ctx.PostValue("secret")
		ctx.Session().Set("secret", secret)

		ctx.Redirect("/user")
	})

	iris.Listen(":8080")
}

Installation

The only requirement is the Go Programming Language, at least v1.7.

$ go get -u github.com/kataras/iris/iris

If you have installation issues or you are connected to the Internet through China please, click here.

Docs & Community

• The most important is to read the practical guide.

• Explore & download the examples.

• HISTORY.md file is your best friend.

If you'd like to discuss this package, or ask questions about it, feel free to

• Post an issue or idea here.
• Chat.

New website-docs & logo have been designed by the community*

• Website created by @kujtimiihoxha
• Logo designed by @OneebMalik

Features

• Focus on high performance
• Robust routing, static, wildcard subdomains and routes.
• Websocket API, Sessions support out of the box
• Remote control through SSH
• View system supporting 6+ template engines.*
• Highly scalable response engines with pre-defined serializers
• Live reload
• Typescript integration + Online editor
• OAuth, OAuth2 supporting 27+ API providers, JWT, BasicAuth
• and many other surprises

Name	Description	Usage
JSON	JSON Serializer (Default)	example 1,example 2, book section
JSONP	JSONP Serializer (Default)	example 1,example 2, book section
XML	XML Serializer (Default)	example 1,example 2, book section
Markdown	Markdown Serializer (Default)	example 1,example 2, book section
Text	Text Serializer (Default)	example 1, book section
Binary Data	Binary Data Serializer (Default)	example 1, book section
HTML/Default Engine	HTML Template Engine (Default)	example , book section
Django Engine	Django Template Engine	example , book section
Pug/Jade Engine	Pug Template Engine	example , book section
Handlebars Engine	Handlebars Template Engine	example , book section
Amber Engine	Amber Template Engine	example , book section
Markdown Engine	Markdown Template Engine	example , book section
Basicauth Middleware	HTTP Basic authentication	example 1, example 2, book section
JWT Middleware	JSON Web Tokens	example , book section
Cors Middleware	Cross Origin Resource Sharing W3 specification	how to use
Secure Middleware	Facilitates some quick security wins	example
I18n Middleware	Simple internationalization	example, book section
Recovery Middleware	Safety recover the station from panic	example
Logger Middleware	Logs every request	example, book section
Editor Plugin	Alm-tools, a typescript online IDE/Editor	book section
Typescript Plugin	Auto-compile client-side typescript files	book section
OAuth,OAuth2 Plugin	User Authentication was never be easier, supports >27 providers	example, book section
Iris control Plugin	Basic (browser-based) control over your Iris station	example, book section

FAQ

Explore these questions or navigate to the community chat.

Philosophy

The Iris philosophy is to provide robust tooling for HTTP, making it a great solution for single page applications, web sites, hybrids, or public HTTP APIs.

Iris does not force you to use any specific ORM or template engine. With support for the most used template engines, you can quickly craft the perfect application.

Iris is built on top of fasthttp (http basic layer), net/http middleware will not work by default on Iris, but you can convert any net/http middleware to Iris, see middleware repository to see how.

If for any personal reasons you think that Iris+fasthttp is not suitable for you, but you don't want to miss the unique features that Iris provides, you can take a look at the HTTP2 Q web framework.

Benchmarks

This Benchmark test aims to compare the whole HTTP request processing between Go web frameworks.

The results have been updated on July 21, 2016

Testing

Community should write third-party or iris base tests to the iris-contrib/tests repository. I recommend writing your API tests using this new library, httpexpect which supports Iris and fasthttp now, after my request here.

Versioning

Current: v4.2.5

Iris is an active project

Read more about Semantic Versioning 2.0.0

• http://semver.org/
• https://en.wikipedia.org/wiki/Software_versioning
• https://wiki.debian.org/UpstreamGuide#Releases_and_Versions

Todo

• Use of the standard log.Logger instead of the iris-contrib/logger(colorful logger), make these changes to all middleware, examples and plugins.
• Implement, even, a better way to manage configuration/options, devs will be able to set their own custom options inside there. I'm thinking of something the last days, but it will have breaking changes.
• Implement an internal updater, as requested here.

Iris is a Community-Driven Project, waiting for your suggestions and feature requests!

I, as the author of this package, am working full time on this package, no time to any other job, so if you're willing to donate and you can afford it please click here, thank you!

People

The big thanks goes to all people who help building this framework with feature-requests & bug reports!

The author of Iris is @kataras.

Contributing

If you are interested in contributing to the Iris project, please see the document CONTRIBUTING.

License

This project is licensed under the Apache License, Version 2.0.

License can be found here.