Add notes for the new lead maintainer of the open-source iris project and align with @get-ion/ion by @hiveminded

Former-commit-id: da4f38eb9034daa49446df3ee529423b98f9b331

_examples/overview/main.go

@@ -0,0 +1,117 @@
+package main
+
+import (
+	"github.com/kataras/iris"
+	"github.com/kataras/iris/context"
+	"github.com/kataras/iris/view"
+)
+
+// User is just a bindable object structure.
+type User struct {
+	Username  string `json:"username"`
+	Firstname string `json:"firstname"`
+	Lastname  string `json:"lastname"`
+	City      string `json:"city"`
+	Age       int    `json:"age"`
+}
+
+func main() {
+	app := iris.New()
+	app.Logger().Level = iris.NoLog
+	// Define templates using the std html/template engine.
+	// Parse and load all files inside "./views" folder with ".html" file extension.
+	// Reload the templates on each request (development mode).
+	app.RegisterView(view.HTML("./views", ".html").Reload(true))
+
+	// Regster custom handler for specific http errors.
+	app.OnErrorCode(iris.StatusInternalServerError, func(ctx context.Context) {
+		// .Values are used to communicate between handlers, middleware.
+		errMessage := ctx.Values().GetString("error")
+		if errMessage != "" {
+			ctx.Writef("Internal server error: %s", errMessage)
+			return
+		}
+
+		ctx.Writef("(Unexpected) internal server error")
+	})
+
+	app.Use(func(ctx context.Context) {
+		ctx.Application().Logger().Infof("Begin request for path: %s", ctx.Path())
+		ctx.Next()
+	})
+	// app.Done(func(ctx context.Context) {]})
+	app.Subdomain("wtf.").Post("/decode", func(ctx context.Context) {})
+	app.Subdomain("wtf.").Post("/decode", func(ctx context.Context) {})
+	// Method POST: http://localhost:8080/decode
+	app.Post("/decode", func(ctx context.Context) {
+		var user User
+		ctx.ReadJSON(&user)
+		ctx.Writef("%s %s is %d years old and comes from %s", user.Firstname, user.Lastname, user.Age, user.City)
+	})
+
+	// Method GET: http://localhost:8080/encode
+	app.Get("/encode", func(ctx context.Context) {
+		doe := User{
+			Username:  "Johndoe",
+			Firstname: "John",
+			Lastname:  "Doe",
+			City:      "Neither FBI knows!!!",
+			Age:       25,
+		}
+
+		ctx.JSON(doe)
+	})
+
+	// Method GET: http://localhost:8080/profile/anytypeofstring
+	app.Get("/profile/{username:string}", profileByUsername)
+
+	usersRoutes := app.Party("/users", logThisMiddleware)
+	{
+		// Method GET: http://localhost:8080/users/42
+		usersRoutes.Get("/{id:int min(1)}", getUserByID)
+		// Method POST: http://localhost:8080/users/create
+		usersRoutes.Post("/create", createUser)
+	}
+
+	// Listen for incoming HTTP/1.x & HTTP/2 clients on localhost port 8080.
+	app.Run(iris.Addr(":8080"), iris.WithCharset("UTF-8"))
+}
+
+func logThisMiddleware(ctx context.Context) {
+	ctx.Application().Logger().Infof("Path: %s | IP: %s", ctx.Path(), ctx.RemoteAddr())
+
+	// .Next is required to move forward to the chain of handlers,
+	// if missing then it stops the execution at this handler.
+	ctx.Next()
+}
+
+func profileByUsername(ctx context.Context) {
+	// .Params are used to get dynamic path parameters.
+	username := ctx.Params().Get("username")
+	ctx.ViewData("Username", username)
+	// renders "./views/users/profile.html"
+	// with {{ .Username }} equals to the username dynamic path parameter.
+	ctx.View("users/profile.html")
+}
+
+func getUserByID(ctx context.Context) {
+	userID := ctx.Params().Get("id") // Or convert directly using: .Values().GetInt/GetInt64 etc...
+	// your own db fetch here instead of user :=...
+	user := User{Username: "username" + userID}
+
+	ctx.XML(user)
+}
+
+func createUser(ctx context.Context) {
+	var user User
+	err := ctx.ReadForm(&user)
+	if err != nil {
+		ctx.Values().Set("error", "creating user, read and parse form failed. "+err.Error())
+		ctx.StatusCode(iris.StatusInternalServerError)
+		return
+	}
+	// renders "./views/users/create_verification.html"
+	// with {{ . }} equals to the User object, i.e {{ .Username }} , {{ .Firstname}} etc...
+	ctx.ViewData("", user)
+	ctx.View("users/create_verification.html")
+}