Skip to content

kjfcpua/iris

 
 

Repository files navigation

Iris Logo

Travis Widget Release Widget Report Widget License Widget Chat Widget Documentation Widget

The fastest web framework for Go.

Alt: Benchmark Wizzard July 21, 2016- Processing Time Horizontal Graph

$ cat render_json.go
package main
import "github.com/kataras/iris"

func main() {
	iris.Get("/hi_json", func(c *iris.Context) {
		c.JSON(iris.StatusOK, iris.Map{
			"Name":  "Iris",
			"Born":  "13 March 2016",
			"Stars": 4420,
		})
	})
	iris.Listen(":8080")
}

Learn more about render

Installation

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

$ 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.

FAQ

Explore these questions or navigate to the community chat.

Features

  • Focus on high performance
  • Robust routing supports static and wildcard subdomains
  • View system supporting 6+ template engines
  • Add custom renders/responses or customize & replace the defaults (context.JSON/JSONP/XML/Markdown/Text/Binary(...))
  • Highly scalable Websocket API with custom events
  • Sessions support with GC, memory & redis providers
  • Middlewares & Plugins were never be easier
  • Full REST API
  • Custom HTTP Errors
  • Typescript compiler + Browser-based editor
  • Content negotiation & streaming
  • Transport Layer Security
  • Reload on source code changes
  • OAuth, OAuth2 supporting 27+ API providers
  • JSON Web Tokens
  • and more

Name Description Usage
JSON JSON Response Engine (Default) example 1,example 2, book section
JSONP JSONP Response Engine (Default) example 1,example 2, book section
XML XML Response Engine (Default) example 1,example 2, book section
Markdown Markdown Response Engine (Default) example 1,example 2, book section
Text Text Response Engine (Default) example 1, book section
Binary Data Binary Data Response Engine (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

Docs & Community

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

Open debates

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.

Benchmarks

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

New results just came out:

Benchmark Wizzard July 21, 2016- Processing Time Horizontal Graph

The results have been updated on July 21, 2016

Please click here to view all detailed benchmarks.

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.0.0-alpha.4

Iris is an active project

Todo

for 'v4'

  • Refactor & extend view engine, separate the engines from the main code base, easier for the community to create new view engines*
  • Refactor & extend sessions, split the different databases functionality to the iris-contrib*
  • Refactor & extends the rest render engine in order to be able to developer to use their own implemention for rendering restful types, like, for example a custom JSON implementation using no-standard go package for encode/decode*
  • Move the iris/websocket package's source code inside iris/websocket.go one file, to be easier to use by users without import a new package*
  • configs package should be removed after all these, we will not need big configurations because of different packages splitted & moved to the iris-contrib, we will keep interfaces and all required things inside kataras/iris.go.
  • Implement all opened community's feature requests
  • Extend i18n middleware for easier and better internalization support
  • Create a router as optional plugin, for optional path parts. Its name, 'ryan', taken from the community-member and donator who requested this feature
  • Extend the iris control plugin
  • Remove deprecated functions
  • Will think more :)

If you're willing to donate click here!

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 MIT License.

License can be found here.

About

The fastest web framework for Go on (THIS) Earth.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 100.0%