mirror of
https://github.com/kataras/iris.git
synced 2025-01-23 18:51:03 +01:00
0b8cb29e0c
Yes new features, with Iris you always get them on each version or revision or non-semantic version
201 lines
10 KiB
Markdown
201 lines
10 KiB
Markdown
[](http://iris-go.com)
|
|
|
|
[![Travis Widget]][Travis] [![Release Widget]][Release] [![Report Widget]][Report] [![License Widget]][License] [![Chat Widget]][Chat] [![Documentation Widget]][Documentation]
|
|
|
|
The [fastest](#benchmarks) web framework for Go.
|
|
|
|
|
|
[](https://github.com/smallnest/go-web-framework-benchmark)
|
|
|
|
|
|
|
|
|
|
```bash
|
|
$ cat render_json.go
|
|
```
|
|
```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": 3693,
|
|
})
|
|
})
|
|
iris.Listen(":8080")
|
|
}
|
|
```
|
|
> Learn more about [render](https://kataras.gitbooks.io/iris/content/render.html)
|
|
|
|
```bash
|
|
$ iris run render_json.go
|
|
```
|
|
|
|
> Runs & monitors for file changes, learn more about [cli](https://github.com/kataras/iris/tree/master/iris).
|
|
|
|
|
|
|
|
Installation
|
|
------------
|
|
The only requirement is the [Go Programming Language](https://golang.org/dl), at least v1.6
|
|
|
|
```bash
|
|
$ go get -u github.com/kataras/iris/iris
|
|
```
|
|
|
|
>If you have installation issues and you are connected to the Internet through China please, [click here](https://kataras.gitbooks.io/iris/content/install.html).
|
|
|
|
FAQ
|
|
------------
|
|
Explore [these questions](https://github.com/kataras/iris/issues?q=label%3Aquestion) or navigate to the [community chat][Chat].
|
|
|
|
|
|
Features
|
|
------------
|
|
- Focus on high performance
|
|
- Robust routing supports static and wildcard subdomains
|
|
- View system supporting [6+](https://kataras.gitbooks.io/iris/content/render_templates.html) template engines
|
|
- 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](https://github.com/kataras/iris/tree/master/iris#run) on source code changes
|
|
- OAuth, OAuth2 supporting 27+ API providers
|
|
- JSON Web Tokens
|
|
- and more
|
|
|
|
<img src="https://raw.githubusercontent.com/iris-contrib/website/gh-pages/assets/arrowdown.png" width="72"/>
|
|
|
|
|
|
| Name | Description | Usage |
|
|
| ------------------|:---------------------:|-------:|
|
|
| [Basicauth Middleware ](https://github.com/iris-contrib/middleware/tree/master/basicauth) | HTTP Basic authentication |[example 1](https://github.com/iris-contrib/examples/blob/master/middleware_basicauth_1/main.go), [example 2](https://github.com/iris-contrib/examples/blob/master/middleware_basicauth_2/main.go), [book section](https://kataras.gitbooks.io/iris/content/basic-authentication.html) |
|
|
| [JWT Middleware ](https://github.com/iris-contrib/middleware/tree/master/jwt) | JSON Web Tokens |[example ](https://github.com/iris-contrib/examples/blob/master/middleware_jwt/main.go), [book section](https://kataras.gitbooks.io/iris/content/jwt.html) |
|
|
| [Cors Middleware ](https://github.com/iris-contrib/middleware/tree/master/cors) | Cross Origin Resource Sharing W3 specification | [how to use ](https://github.com/iris-contrib/middleware/tree/master/cors#how-to-use) |
|
|
| [Secure Middleware ](https://github.com/iris-contrib/middleware/tree/master/secure) | Facilitates some quick security wins | [example](https://github.com/iris-contrib/examples/blob/master/middleware_secure/main.go) |
|
|
| [I18n Middleware ](https://github.com/iris-contrib/middleware/tree/master/i18n) | Simple internationalization | [example](https://github.com/iris-contrib/examples/tree/master/middleware_internationalization_i18n), [book section](https://kataras.gitbooks.io/iris/content/middleware-internationalization-and-localization.html) |
|
|
| [Recovery Middleware ](https://github.com/iris-contrib/middleware/tree/master/recovery) | Safety recover the station from panic | [example](https://github.com/iris-contrib/examples/blob/master/middleware_recovery/main.go) |
|
|
| [Logger Middleware ](https://github.com/iris-contrib/middleware/tree/master/logger) | Logs every request | [example](https://github.com/iris-contrib/examples/blob/master/middleware_logger/main.go), [book section](https://kataras.gitbooks.io/iris/content/logger.html) |
|
|
| [Editor Plugin](https://github.com/iris-contrib/plugin/tree/master/editor) | Alm-tools, a typescript online IDE/Editor | [book section](https://kataras.gitbooks.io/iris/content/plugin-editor.html) |
|
|
| [Typescript Plugin](https://github.com/iris-contrib/plugin/tree/master/typescript) | Auto-compile client-side typescript files | [book section](https://kataras.gitbooks.io/iris/content/plugin-typescript.html) |
|
|
| [OAuth,OAuth2 Plugin](https://github.com/iris-contrib/plugin/tree/master/oauth) | User Authentication was never be easier, supports >27 providers | [example](https://github.com/iris-contrib/examples/tree/master/plugin_oauth_oauth2), [book section](https://kataras.gitbooks.io/iris/content/plugin-oauth.html) |
|
|
| [Iris control Plugin](https://github.com/iris-contrib/plugin/tree/master/iriscontrol) | Basic (browser-based) control over your Iris station | [example](https://github.com/iris-contrib/examples/blob/master/plugin_iriscontrol/main.go), [book section](https://kataras.gitbooks.io/iris/content/plugin-iriscontrol.html) |
|
|
|
|
Docs & Community
|
|
------------
|
|
|
|
<a href="https://www.gitbook.com/book/kataras/iris/details"><img align="right" width="185" src="https://raw.githubusercontent.com/iris-contrib/website/gh-pages/assets/book/cover_1.png"></a>
|
|
|
|
|
|
- Read the [book](https://www.gitbook.com/book/kataras/iris/details) or [wiki](https://github.com/kataras/iris/wiki)
|
|
|
|
- Take a look at the [examples](https://github.com/iris-contrib/examples)
|
|
|
|
- [HISTORY](https://github.com//kataras/iris/tree/master/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](https://github.com/kataras/iris/issues)
|
|
* [Chat][Chat]
|
|
|
|
Open debates
|
|
|
|
- [Contribute: New website and logo for Iris](https://github.com/kataras/iris/issues/153)
|
|
- [E-book Cover - Which one you suggest?](https://github.com/kataras/iris/issues/67)
|
|
|
|
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](https://github.com/smallnest/go-web-framework-benchmark) aims to compare the whole HTTP request processing between Go web frameworks.
|
|
|
|
**New results just came out:**
|
|
|
|
|
|
|
|
**The results have been updated on July 1, 2016**
|
|
|
|
[Please click here to view all detailed benchmarks.](https://github.com/smallnest/go-web-framework-benchmark)
|
|
|
|
Testing
|
|
------------
|
|
|
|
Tests are located to the [iris-contrib/tests repository](https://github.com/iris-contrib/tests), community should write some code there!
|
|
I recommend writing your API tests using this new library, [httpexpect](https://github.com/gavv/httpexpect) which supports Iris and fasthttp now, after my request [here](https://github.com/gavv/httpexpect/issues/2).
|
|
|
|
Versioning
|
|
------------
|
|
|
|
Current: **v3.0.0-pre.release**
|
|
> 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
|
|
------------
|
|
> for the next release 'v3'
|
|
|
|
- [x] [Dynamic/Wildcard subdomains](https://kataras.gitbooks.io/iris/content/subdomains.html)
|
|
- [x] [Create server & client side](https://kataras.gitbooks.io/iris/content/package-websocket.html) (js) library for .on('event', func action(...)) / .emit('event')... (like socket.io but supports only websocket)
|
|
- [x] [Create a view system](https://kataras.gitbooks.io/iris/content/render_templates.html) supporting different types of template engines
|
|
- [x] Extend, test and publish to the public the [Iris' cmd](https://github.com/kataras/iris/tree/master/iris)[*](https://github.com/kataras/rizla)
|
|
- [ ] Complete the API tests, community can help also, tests are located [here](https://github.com/iris-contrib/tests).
|
|
|
|
|
|
If you're **willing to donate** click [here](DONATIONS.md)!
|
|
|
|
People
|
|
------------
|
|
A big thanks goes to [all people](https://github.com/kataras/iris/issues?utf8=%E2%9C%93&q=label%3A%22feature+request%22) who help building this framework with feature-requests & bug reports!
|
|
|
|
The author of Iris is [@kataras](https://github.com/kataras).
|
|
|
|
|
|
Contributing
|
|
------------
|
|
If you are interested in contributing to the Iris project, please see the document [CONTRIBUTING](https://github.com/kataras/iris/blob/master/CONTRIBUTING.md).
|
|
|
|
License
|
|
------------
|
|
|
|
This project is licensed under the MIT License.
|
|
|
|
License can be found [here](LICENSE).
|
|
|
|
[Travis Widget]: https://img.shields.io/travis/kataras/iris.svg?style=flat-square
|
|
[Travis]: http://travis-ci.org/kataras/iris
|
|
[License Widget]: https://img.shields.io/badge/license-MIT%20%20License%20-E91E63.svg?style=flat-square
|
|
[License]: https://github.com/kataras/iris/blob/master/LICENSE
|
|
[Release Widget]: https://img.shields.io/badge/release-v3.0.0--pre.release-blue.svg?style=flat-square
|
|
[Release]: https://github.com/kataras/iris/releases
|
|
[Chat Widget]: https://img.shields.io/badge/community-chat-00BCD4.svg?style=flat-square
|
|
[Chat]: https://kataras.rocket.chat/channel/iris
|
|
[ChatMain]: https://kataras.rocket.chat/channel/iris
|
|
[ChatAlternative]: https://gitter.im/kataras/iris
|
|
[Report Widget]: https://img.shields.io/badge/report%20card-A%2B-F44336.svg?style=flat-square
|
|
[Report]: http://goreportcard.com/report/kataras/iris
|
|
[Documentation Widget]: https://img.shields.io/badge/documentation-reference-5272B4.svg?style=flat-square
|
|
[Documentation]: https://www.gitbook.com/book/kataras/iris/details
|
|
[Language Widget]: https://img.shields.io/badge/powered_by-Go-3362c2.svg?style=flat-square
|
|
[Language]: http://golang.org
|
|
[Platform Widget]: https://img.shields.io/badge/platform-Any--OS-gray.svg?style=flat-square
|