Iris is a fast, simple and efficient micro web framework for Go. It provides a beautifully expressive and easy to use foundation for your next website, API, or distributed app.
We have no doubt you will able to find other web frameworks written in Go and even put up a real fight to learn and use them for quite some time but make no mistake, sooner or later you will be using Iris, not because of the ergonomic, high-performant solution that it provides but its well-documented unique features, as these will transform you to a real rockstar geek.
No matter what you're trying to build, Iris covers every type of application, from micro services to large monolithic web applications. It's actually the best piece of software for back-end web developers you can find online.
Iris may have reached version 8, but we're not stopping there. We have many feature ideas on our board that we're anxious to add and other innovative web development solutions that we're planning to build into Iris.
Star or watch this repository to stay updated.
Accelerated by KeyCDN, A Simple, Fast and Reliable CDN.
- Installation
- Latest changes
- Learn
- HTTP Listening
- Configuration
- Routing, Grouping, Dynamic Path Parameters, "Macros" and Custom Context
- MVC (Model View Controller) NEW
- Subdomains
- Wrap
http.Handler/HandlerFunc - View
- Authentication
- File Server
- How to Read from
context.Request() *http.Request - How to Write to
context.ResponseWriter() http.ResponseWriter - Test
- Cache
- Sessions
- Websockets
- Miscellaneous
- POC: Convert the medium-sized project "Parrot" from native to Iris
- Typescript Automation Tools
- Tutorial: Online Visitors
- Tutorial: Caddy
- Middleware
- Dockerize
- Community & Support
- Blogs
- Iris Go vs .NET Core Kestrel in terms of HTTP performance
- Go vs .NET Core in terms of HTTP performance
- Iris, a modular web framework
- Deploying a Iris Golang app in hasura
- How to Turn an Android Device into a Web Server
- A URL Shortener Service using Go, Iris and Bolt
- Why I preferred Go over Node.js for simple Web Application
- Versioning
- People
The only requirement is the Go Programming Language, at least version 1.8 but 1.9 is highly recommended.
$ go get -u github.com/kataras/irisiris takes advantage of the vendor directory feature. You get truly reproducible builds, as this method guards against upstream renames and deletes.
// file: main.go
package main
import "github.com/kataras/iris"
func main() {
app := iris.New()
// Load all templates from the "./views" folder
// where extension is ".html" and parse them
// using the standard `html/template` package.
app.RegisterView(iris.HTML("./views", ".html"))
// Method: GET
// Resource: http://localhost:8080
app.Get("/", func(ctx iris.Context) {
// Bind: {{.message}} with "Hello world!"
ctx.ViewData("message", "Hello world!")
// Render template file: ./views/hello.html
ctx.View("hello.html")
})
// Method: GET
// Resource: http://localhost:8080/user/42
app.Get("/user/{id:long}", func(ctx iris.Context) {
userID, _ := ctx.Params().GetInt64("id")
ctx.Writef("User ID: %d", userID)
})
// Start the server using a network address.
app.Run(iris.Addr(":8080"))
}<!-- file: ./views/hello.html -->
<html>
<head>
<title>Hello Page</title>
</head>
<body>
<h1>{{.message}}</h1>
</body>
</html>$ go run main.go
> Now listening on: http://localhost:8080
> Application started. Press CTRL+C to shut down.Hello World with Go 1.8
Iris declares all of its type alias at the same file in order to be easy to be discovered.
If you just upgraded to go 1.9 from 1.8 you can always search for a compatible type alias at the context.go file and opposite, if you use go 1.8 and you're new to Iris you can see that file to see the compatible packages.
If Go 1.8 remains the basic host for your go apps then you should declare and use the github.com/kataras/iris/context package on your source file's imports statement.
package main
import (
"github.com/kataras/iris"
"github.com/kataras/iris/context"
)
func main() {
app := iris.New()
app.RegisterView(iris.HTML("./templates", ".html"))
app.Get("/", func(ctx context.Context) {
ctx.ViewData("message", "Hello world!")
ctx.View("hello.html")
})
app.Run(iris.Addr(":8080"))
}Fan of the MVC Architectural Pattern? Click here
package main
import "github.com/kataras/iris"
func main() {
app := iris.New()
app.RegisterView(iris.HTML("./views", ".html"))
app.Controller("/", new(Controller))
app.Run(iris.Addr(":8080"))
}
type Controller struct {
iris.Controller
}
// Method: GET
// Resource: http://localhost:8080
func (c *Controller) Get() {
c.Data["message"] = "Hello world!"
c.Tmpl = "hello.html"
}
// Method: GET
// Resource: http://localhost:8080/user/42
func (c *Controller) GetUserBy(id int64) {
c.Ctx.Writef("User ID: %d", id)
}Why a new web framework
Go is a great technology stack for building scalable, web-based, back-end systems for web applications.
When you think about building web applications and web APIs, or simply building HTTP servers in Go, does your mind go to the standard net/http package? Then you have to deal with some common situations like dynamic routing (a.k.a parameterized), security and authentication, real-time communication and many other issues that net/http doesn't solve.
The net/http package is not complete enough to quickly build well-designed back-end web systems. When you realize this, you might be thinking along these lines:
- Ok, the net/http package doesn't suit me, but there are so many frameworks, which one will work for me?!
- Each one of them tells me that it is the best. I don't know what to do!
I did some deep research and benchmarks with 'wrk' and 'ab' in order to choose which framework would suit me and my new project. The results, sadly, were really disappointing to me.
I started wondering if golang wasn't as fast on the web as I had read... but, before I let Golang go and continued to develop with nodejs, I told myself:
'Makis, don't lose hope, give at least a chance to Golang. Try to build something totally new without basing it off the "slow" code you saw earlier; learn the secrets of this language and make others follow your steps!'.
These are the words I told myself that day [13 March 2016].
The same day, later the night, I was reading a book about Greek mythology. I saw an ancient goddess' name and was inspired immediately to give a name to this new web framework (which I had already started writing) - Iris.
I'm still here because Iris has succeed in being the fastest go web framework
iris is easy, it has a familiar API while in the same has far more features than Gin or Martini.
You own your code —it will never generate (unfamiliar) code for you, like Beego, Revel and Buffalo do.
It's not just-another-router but its overall performance is equivalent with something like httprouter.
Unlike fasthttp, iris provides full HTTP/2 support for free.
Compared to the rest open source projects, this one is very active and you get answers almost immediately.
- Focus on high performance
- Easy Fluent API
- Highly customizable
- Robust routing and middleware ecosystem
- Build RESTful APIs with iris unique expressionist path interpreter
- Dynamic path parameterized or wildcard routes are not conflict with static routes
- Remove trailing slash from the URL with option to redirect
- Virtual hosts and subdomains made easy
- Group API's and static or even dynamic subdomains
- MVC NEW
net/httpandnegroni-likehandlers are compatible viairis.FromStd- Register custom handlers for any HTTP error
- Transactions and rollback when you need it
- Cache the response when you need it
- A single function to serve your embedded assets, always compatible with
go-bindata - HTTP to HTTPS
- HTTP to HTTPS WWW
- learn the reasons that differ from what you've seen so far
- Context
- Highly scalable rich content render (Markdown, JSON, JSONP, XML...)
- Body binders and handy functions to send HTTP responses
- Limit request body
- Serve static resources or embedded assets
- Localization i18N
- Compression (Gzip is built'n)
- Authentication
- Basic Authentication
- OAuth, OAuth2 supporting 27+ popular websites
- JWT
- Server
- Automatically install and serve certificates from https://letsencrypt.org when serving via TLS
- Gracefully shutdown by-default
- Register on shutdown, error or interrupt events
- Attach more than one server, fully compatible with
net/http#Server
- View system: supporting 5 template engines. Fully compatible with
html/template - HTTP Sessions library [you can still use your favorite if you want to]
- Websocket library, its API similar to socket.io [you can still use your favorite if you want to]
- Hot Reload on source code changes*
- Typescript integration + Web IDE
- And many other things that will surprise you
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. Keep note that, today, iris is faster than apache+nginx itself.
iris does not force you to use any specific ORM. With support for the most popular template engines, websocket server and a fast sessions manager you can quickly craft your perfect application.
The awesome iris community is always adding new examples, _examples is a great place to get started!
Read the godocs for a better understanding.
Join the welcoming community of fellow iris developers in rocket.chat
- Post a feature request or report a bug
- ⭐ and watch the public repository, will keep you up to date
- 🌎 publish an article or share a tweet about your personal experience with iris.
The most useful community repository for iris developers is the iris-contrib/middleware which contains some HTTP handlers that can help you finish a lot of your tasks even easier. Feel free to push your own middleware there!
$ go get -u github.com/iris-contrib/middleware/...Iris exceeded all expectations, started as one-man project.
- 7300 github stars
- 778 github forks
- 1m total views at its documentation
- ~819$ at donations, small amount for the work we put here but it's a good start
- ~557 reported bugs fixed
- ~30 community feature requests have been implemented
Current: VERSION
Each new release is pushed to the master. It stays there until the next version. When a next version is released then the previous version goes to its own branch with gopkg.in as its import path (and its own vendor folder), in order to keep it working "for-ever".
Changelog of the current version can be found at the HISTORY file.
Developers are not forced to use the latest iris version, they can use any version in production, they can update at any time they want.
Testers should upgrade immediately, if you're willing to use iris in production you can wait a little more longer, transaction should be as safe as possible.
Previous versions can be found at releases page.
The original author of Iris is @kataras, you can reach him via
Help this project to continue deliver awesome and unique features with the higher code quality as possible by donating any amount
This software is licensed under the open-source 3-Clause BSD.
You can find the license file here, for any questions regarding the license please contact us.