iris/_examples/README.md

Examples

Please do learn how net/http std package works, first.

This folder provides easy to understand code snippets on how to get started with iris micro web framework.

It doesn't always contain the "best ways" but it does cover each important feature that will make you so excited to GO with iris!

Overview

• Hello world!
• Glimpse
• Tutorial: Online Visitors
• Tutorial: URL Shortener using BoltDB
• Tutorial: How to turn your Android Device into a fully featured Web Server

HTTP Listening

• Common, with address
  • omit server errors
• UNIX socket file
• TLS
• Letsencrypt (Automatic Certifications)
• Notify on shutdown
• Custom TCP Listener
  • common net.Listener
  • SO_REUSEPORT for unix systems
• Custom HTTP Server
  • easy way
  • std way
  • multi server instances
• Graceful Shutdown
  • using the RegisterOnInterrupt
  • using a custom notifier

Configuration

• Functional
• From Configuration Struct
• Import from YAML file
• Import from TOML file

Routing, Grouping, Dynamic Path Parameters, "Macros" and Custom Context

• app.Get("{userid:int min(1)}", myHandler)
• app.Post("{asset:path}", myHandler)
• app.Put("{custom:string regexp([a-z]+)}", myHandler)

Note: unlike other routers you'd seen, iris' router can handle things like these:

// Matches all GET requests prefixed with "/assets/"
app.Get("/assets/{asset:path}", assetsWildcardHandler)

// Matches only GET "/"
app.Get("/", indexHandler)
// Matches only GET "/about"
app.Get("/about", aboutHandler)

// Matches all GET requests prefixed with "/profile/"
// and followed by a single path part
app.Get("/profile/{username:string}", userHandler)
// Matches only GET "/profile/me" because 
// it does not conflict with /profile/{username:string}
// or the root wildcard {root:path}
app.Get("/profile/me", userHandler)

// Matches all GET requests prefixed with /users/
// and followed by a number which should be equal or bigger than 1
app.Get("/user/{userid:int min(1)}", getUserHandler)
// Matches all requests DELETE prefixed with /users/
// and following by a number which should be equal or bigger than 1
app.Delete("/user/{userid:int min(1)}", deleteUserHandler)

// Matches all GET requests except "/", "/about", anything starts with "/assets/" etc...
// because it does not conflict with the rest of the routes.
app.Get("{root:path}", rootWildcardHandler)

Navigate through examples for a better understanding.

• Overview
• Basic
• Custom HTTP Errors
• Dynamic Path
  • root level wildcard path
• Reverse routing
• Custom wrapper
• Custom Context
  • method overriding
  • new implementation
• Route State

Subdomains

• Single
• Multi
• Wildcard
• WWW

Convert http.Handler/HandlerFunc

• From func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)
• From http.Handler or http.HandlerFunc

View

Engine	Declaration
template/html	iris.HTML(...)
django	iris.Django(...)
handlebars	iris.Handlebars(...)
amber	iris.Amber(...)
pug(jade)	iris.Pug(...)

• Overview
• Hi
• A simple Layout
• Layouts: yield and render tmpl funcs
• The urlpath tmpl func
• The url tmpl func
• Inject Data Between Handlers
• Embedding Templates Into App Executable File

You can serve quicktemplate files too, simply by using the context#ResponseWriter, take a look at the http_responsewriter/quicktemplate example.

Authentication

• Basic Authentication
• OAUth2
• JWT
• Sessions

File Server

• Favicon
• Basic
• Embedding Files Into App Executable File
• Send/Force-Download Files
• Single Page Applications
  • single Page Application
  • embedded Single Page Application

How to Read from context.Request() *http.Request

• Bind JSON
• Bind Form
• Upload/Read Files

The context.Request() returns the same *http.Request you already know, these examples show some places where the Context uses this object. Besides that you can use it as you did before iris.

How to Write to context.ResponseWriter() http.ResponseWriter

• Write valyala/quicktemplate templates
• Text, Markdown, HTML, JSON, JSONP, XML, Binary
• Stream Writer
• Transactions

The context.ResponseWriter() returns an enchament version of a http.ResponseWriter, these examples show some places where the Context uses this object. Besides that you can use it as you did before iris.

ORM

• Using xorm(Mysql, MyMysql, Postgres, Tidb, SQLite, MsSql, MsSql, Oracle)

Miscellaneous

• Request Logger
  • log requests to a file
• Localization and Internationalization
• Recovery
• Profiling (pprof)
• Internal Application File Logger
• Google reCAPTCHA

More

https://github.com/kataras/iris/tree/master/middleware#third-party-handlers

Testing

The httptest package is your way for end-to-end HTTP testing, it uses the httpexpect library created by our friend, gavv.

Example

Caching

iris cache library lives on its own package.

• Simple

You're free to use your own favourite caching package if you'd like so.

Sessions

iris session manager lives on its own package.

• Overview
• Standalone
• Secure Cookie
• Flash Messages
• Databases
  • File
  • BoltDB
  • Redis

You're free to use your own favourite sessions package if you'd like so.

Websockets

iris websocket library lives on its own package.

• Chat
• Native Messages
• Connection List
• TLS Enabled
• Custom Raw Go Client

You're free to use your own favourite websockets package if you'd like so.

Typescript Automation Tools

typescript automation tools have their own repository: https://github.com/kataras/iris/tree/master/typescript it contains examples

I'd like to tell you that you can use your favourite but I don't think you will find such a thing anywhere else.

Hey, You!

Developers should read the godocs for a better understanding.

Psst, I almost forgot; do not forget to star or watch the project in order to stay updated with the latest tech trends, it never takes more than a second!