iris/_examples

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 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!

Running the examples

1. Install the Go Programming Language, version 1.12+ from https://golang.org/dl.
2. Install Iris
3. Install any external packages that required by the examples

External packages

cd _examples && go get ./...

And run each example you wanna see, e.g.

$ cd $GOPATH/src/github.com/kataras/iris/_examples/overview
$ go run main.go

Test the examples by opening a terminal window and execute: go test -v ./...

Overview

• Hello world!
• Docker
• Hello WebAssembly!
• Glimpse
• Tutorial: Online Visitors
• Tutorial: A Todo MVC Application using Iris and Vue.js
• Tutorial: URL Shortener using BoltDB
• Tutorial: How to turn your Android Device into a fully featured Web Server (MUST)
• POC: Convert the medium-sized project "Parrot" from native to Iris
• POC: Isomorphic react/hot reloadable/redux/css-modules starter kit
• Tutorial: DropzoneJS Uploader
• Tutorial: Caddy
• Tutorial:Iris Go Framework + MongoDB
• Tutorial: API for Apache Kafka

Structuring

Nothing stops you from using your favorite folder structure. Iris is a low level web framework, it has got MVC first-class support but it doesn't limit your folder structure, this is your choice.

Structuring depends on your own needs. We can't tell you how to design your own application for sure but you're free to take a closer look to the examples below; you may find something useful that you can borrow for your app;

• Bootstrapper
• MVC with Repository and Service layer Overview
• Login (MVC with Single Responsibility package)
• Login (MVC with Datamodels, Datasource, Repository and Service layer)

HTTP Listening

• Common, with address
  • public domain 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
  • HTTP/3 Quic
  • 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
  • Share Configuration between multiple instances
• 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
• Controllers
• Custom HTTP Errors
• Not Found - Suggest Closest Paths NEW
• Dynamic Path
  • root level wildcard path
• Write your own custom parameter types
• Reverse routing
• Custom Router (high-level)
• Custom Wrapper
• Custom Context
  • method overriding
  • new implementation
• Route State
• Writing a middleware
  • per-route
  • globally
• Route Register Rule NEW

Versioning

• How it works
• Example

Dependency Injection

• Basic
• Overview
• Sessions
• Yet another dependency injection example and good practises at general

MVC

• Hello world
• Basic
• Basic: wildcard NEW
• Regexp
• Session Controller
• Overview - Plus Repository and Service layers
• Login showcase - Plus Repository and Service layers
• Singleton
• Websocket Controller
• Register Middleware
• Vue.js Todo MVC
• gRPC-compatible controller NEW

Subdomains

• Single
• Multi
• Wildcard
• WWW
• Redirect fast

Convert http.Handler/HandlerFunc

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

View

• 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
• Write to a custom io.Writer
• Greeting with Pug (Jade)`
• Pug (Jade) Actions`
• Pug (Jade) Includes`
• Pug (Jade) Extends`
• Jet
• Jet Embedded
• Jet 'urlpath' tmpl func
• Jet template funcs from structure

You can serve quicktemplate and hero templates files too, simply by using the context#ResponseWriter, take a look at the http_responsewriter/quicktemplate and http_responsewriter/herotemplate examples.

Localization and Internationalization

• I18n NEW

Sitemap

• Sitemap NEW

Desktop App

• Using blink package NEW
• Using lorca package NEW
• Using webview package NEW

Authentication

• Basic Authentication
• OAUth2
• Request Auth(JWT)
• Sessions

File Server

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

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

• Read JSON
  • Struct Validation UPDATED
• Read XML
• Read MsgPack NEW
• Read YAML
• Read Form
• Read Query
• Read Body NEW
• Read Custom per type
• Read Custom via Unmarshaler
• Read Many times
• Upload/Read File
• Upload multiple files with an easy way
• Extract referrer from "referer" header or URL query parameter

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

• Content Negotiation
• Write valyala/quicktemplate templates
• Write shiyanhui/hero templates
• Text, Markdown, HTML, JSON, JSONP, XML, Binary
• Write Gzip
• Stream Writer
• Transactions
• SSE
• SSE (third-party package usage for server sent events)

The context/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)
• Using gorm

Miscellaneous

• Rate Limit NEW
• HTTP Method Override
• Request Logger
  • log requests to a file
• Recovery
• Profiling (pprof)
• Internal Application File Logger
• Google reCAPTCHA
• hCaptcha NEW

Community-based Handlers

• Casbin wrapper
• Casbin middleware
• Cloudwatch
• CORS
• JWT
• Newrelic
• Prometheus
• Secure
• Tollboothic
• Cross-Site Request Forgery Protection

More

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

Automated API Documentation

• yaag

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
• Client-Side (304) - part of the iris context core

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

Cookies

• Basic
• Encode/Decode (securecookie)

Sessions

iris session manager lives on its own package.

• Overview
• Middleware
• Secure Cookie
• Flash Messages
• Databases
  • Badger
  • BoltDB
  • Redis

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

Websockets

• Basic
  • Server
  • Go Client
  • Browser Client
  • Browser NPM Client (browserify)
• Native Messages
• TLS Enabled

Hey, You

Developers should read the godocs and https://docs.iris-go.com 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!