reorganization of _examples and add some new examples such as iris+gr…

…oupcache+mysql+docker

Former-commit-id: ed635ee95de7160cde11eaabc0c1dcb0e460a620

HISTORY.md

@@ -159,7 +159,7 @@ Prior to this version the `iris.Context` was the only one dependency that has be
 | `float, float32, float64`, | |
 | `bool`, | |
 | `slice` | [Path Parameter](https://github.com/kataras/iris/wiki/Routing-path-parameter-types) |
-| Struct | [Request Body](https://github.com/kataras/iris/tree/master/_examples/http_request) of `JSON`, `XML`, `YAML`, `Form`, `URL Query`, `Protobuf`, `MsgPack` |
+| Struct | [Request Body](https://github.com/kataras/iris/tree/master/_examples/request-body) of `JSON`, `XML`, `YAML`, `Form`, `URL Query`, `Protobuf`, `MsgPack` |
 
 Here is a preview of what the new Hero handlers look like:
 
@@ -393,7 +393,7 @@ Other Improvements:
 
 - New `iris.WithLowercaseRouting` option which forces all routes' paths to be lowercase and converts request paths to their lowercase for matching.
 
-- New `app.Validator { Struct(interface{}) error }` field and `app.Validate` method were added. The `app.Validator = ` can be used to integrate a 3rd-party package such as [go-playground/validator](https://github.com/go-playground/validator). If set-ed then Iris `Context`'s `ReadJSON`, `ReadXML`, `ReadMsgPack`, `ReadYAML`, `ReadForm`, `ReadQuery`, `ReadBody` methods will return the validation error on data validation failures. The [read-json-struct-validation](_examples/http_request/read-json-struct-validation) example was updated.
+- New `app.Validator { Struct(interface{}) error }` field and `app.Validate` method were added. The `app.Validator = ` can be used to integrate a 3rd-party package such as [go-playground/validator](https://github.com/go-playground/validator). If set-ed then Iris `Context`'s `ReadJSON`, `ReadXML`, `ReadMsgPack`, `ReadYAML`, `ReadForm`, `ReadQuery`, `ReadBody` methods will return the validation error on data validation failures. The [read-json-struct-validation](_examples/request-body/read-json-struct-validation) example was updated.
 
 - A result of <T> can implement the new `hero.PreflightResult` interface which contains a single method of `Preflight(iris.Context) error`. If this method exists on a custom struct value which is returned from a handler then it will fire that `Preflight` first and if not errored then it will cotninue by sending the struct value as JSON(by-default) response body.
 
@@ -415,7 +415,7 @@ New Package-level Variables:
 
 New Context Methods:
 
-- `Context.GzipReader(enable bool)` method and `iris.GzipReader` middleware to enable future request read body calls to decompress data using gzip, [example](_examples/http_request/read-gzip).
+- `Context.GzipReader(enable bool)` method and `iris.GzipReader` middleware to enable future request read body calls to decompress data using gzip, [example](_examples/request-body/read-gzip).
 - `Context.RegisterDependency(v interface{})` and `Context.RemoveDependency(typ reflect.Type)` to register/remove struct dependencies on serve-time through a middleware.
 - `Context.SetID(id interface{})` and `Context.GetID() interface{}` added to register a custom unique indetifier to the Context, if necessary.
 - `Context.GetDomain() string` returns the domain.
@@ -476,7 +476,6 @@ Implement **new** `SetRegisterRule(iris.RouteOverride, RouteSkip, RouteError)` t
 
 New Examples:
 
-- [_examples/Docker](_examples/Docker)
 - [_examples/routing/route-register-rule](_examples/routing/route-register-rule)
 
 # We, 05 February 2020 | v12.1.6
@@ -570,10 +569,10 @@ Navigate through: https://github.com/kataras/iris/wiki/Sitemap for more.
 ## New Examples
 
 2. [_examples/i18n](_examples/i18n)
-1. [_examples/sitemap](_examples/sitemap)
-3. [_examples/desktop-app/blink](_examples/desktop-app/blink)
-4. [_examples/desktop-app/lorca](_examples/desktop-app/lorca)
-5. [_examples/desktop-app/webview](_examples/desktop-app/webview)
+1. [_examples/sitemap](_examples/routing/sitemap)
+3. [_examples/desktop/blink](_examples/desktop/blink)
+4. [_examples/desktop/lorca](_examples/desktop/lorca)
+5. [_examples/desktop/webview](_examples/desktop/webview)
 
 # Sa, 26 October 2019 | v12.0.0
 
@@ -603,7 +602,7 @@ The iris-contrib/middleare and examples are updated to use the new `github.com/k
 # Fr, 16 August 2019 | v11.2.8
 
 - Set `Cookie.SameSite` to `Lax` when subdomains sessions share is enabled[*](https://github.com/kataras/iris/commit/6bbdd3db9139f9038641ce6f00f7b4bab6e62550)
-- Add and update all [experimental handlers](https://github.com/kataras/iris/tree/master/_examples/experimental-handlers) 
+- Add and update all [experimental handlers](https://github.com/iris-contrib/middleware) 
 - New `XMLMap` function which wraps a `map[string]interface{}` and converts it to a valid xml content to render through `Context.XML` method
 - Add new `ProblemOptions.XML` and `RenderXML` fields to render the `Problem` as XML(application/problem+xml) instead of JSON("application/problem+json) and enrich the `Negotiate` to easily accept the `application/problem+xml` mime.
 
@@ -657,7 +656,7 @@ Commit log: https://github.com/kataras/iris/compare/v11.2.3...v11.2.4
 
 - [New Feature: Handle different parameter types in the same path](https://github.com/kataras/iris/issues/1315)
 - [New Feature: Content Negotiation](https://github.com/kataras/iris/issues/1319)
-- [Context.ReadYAML](https://github.com/kataras/iris/tree/master/_examples/http_request/read-yaml)
+- [Context.ReadYAML](https://github.com/kataras/iris/tree/master/_examples/request-body/read-yaml)
 - Fixes https://github.com/kataras/neffos/issues/1#issuecomment-515698536
 
 # We, 24 July 2019 | v11.2.2

HISTORY_ES.md

@@ -108,7 +108,7 @@ Registro de commits: https://github.com/kataras/iris/compare/v11.2.3...v11.2.4
 
 - [Nueva característica: Manejar diferentes tipos de parámetros en la misma ruta](https://github.com/kataras/iris/issues/1315)
 - [Nueva característica: Negociación de contenido](https://github.com/kataras/iris/issues/1319)
-- [Context.ReadYAML](https://github.com/kataras/iris/tree/master/_examples/http_request/read-yaml)
+- [Context.ReadYAML](https://github.com/kataras/iris/tree/master/_examples/request-body/read-yaml)
 - Ajustes https://github.com/kataras/neffos/issues/1#issuecomment-515698536
 
 # Miércoles, 24 de julio 2019 | v11.2.2

_examples/README.md

@@ -1,31 +1,30 @@
 # Table of Contents
 
-* Tutorials
-    * [Dockerize](tutorial/docker)
-    * [Caddy](tutorial/caddy)
-    * [MongoDB](tutorial/mongodb)
-    * [Dropzone.js](tutorial/dropzonejs)
-    * [URL Shortener](tutorial/url-shortener/main.go)
-    * [Online Visitors](tutorial/online-visitors/main.go)
-    * [REST API for Apache Kafka](tutorial/api-for-apache-kafka)
-    * [Vue.js Todo (MVC)](tutorial/vuejs-todo-mvc)
-    * [gRPC (MVC)](mvc/grpc-compatible)
-* HTTP Listening
-    * [HOST:PORT](http-listening/listen-addr/main.go)
-    * [Public Test Domain](http-listening/listen-addr-public/main.go)
-    * [UNIX socket file](http-listening/listen-unix/main.go)
-    * [TLS](http-listening/listen-tls/main.go)
-    * [Letsencrypt (Automatic Certifications)](http-listening/listen-letsencrypt/main.go)
-    * [Graceful Shutdown](http-listening/graceful-shutdown/default-notifier/main.go)
-    * [Notify on shutdown](http-listening/notify-on-shutdown/main.go)
+* [REST API for Apache Kafka](kafka-api)
+* [URL Shortener](url-shortener)
+* [Dropzone.js](dropzonejs)
+* [Caddy](caddy)
+* Database
+    * [MySQL, Groupcache & Docker](database/mysql)
+    * [MongoDB](database/mongodb)
+    * [Xorm](database/orm/xorm/main.go)
+    * [Gorm](database/orm/gorm/main.go)
+* HTTP Server
+    * [HOST:PORT](http-server/listen-addr/main.go)
+    * [Public Test Domain](http-server/listen-addr-public/main.go)
+    * [UNIX socket file](http-server/listen-unix/main.go)
+    * [TLS](http-server/listen-tls/main.go)
+    * [Letsencrypt (Automatic Certifications)](http-server/listen-letsencrypt/main.go)
+    * [Graceful Shutdown](http-server/graceful-shutdown/default-notifier/main.go)
+    * [Notify on shutdown](http-server/notify-on-shutdown/main.go)
     * Custom TCP Listener
-        * [Common net.Listener](http-listening/custom-listener/main.go)
-        * [SO_REUSEPORT for unix systems](http-listening/custom-listener/unix-reuseport/main.go)
+        * [Common net.Listener](http-server/custom-listener/main.go)
+        * [SO_REUSEPORT for unix systems](http-server/custom-listener/unix-reuseport/main.go)
     * Custom HTTP Server
-        * [Pass a custom Server](http-listening/custom-httpserver/easy-way/main.go)
-        * [Use Iris as a single http.Handler](http-listening/custom-httpserver/std-way/main.go)
-        * [Multi Instances](http-listening/custom-httpserver/multi/main.go)
-        * [HTTP/3 Quic](http-listening/http3-quic)
+        * [Pass a custom Server](http-server/custom-httpserver/easy-way/main.go)
+        * [Use Iris as a single http.Handler](http-server/custom-httpserver/std-way/main.go)
+        * [Multi Instances](http-server/custom-httpserver/multi/main.go)
+        * [HTTP/3 Quic](http-server/http3-quic)
 * Configuration
     * [Functional](configuration/functional/main.go)
     * [Configuration Struct](configuration/from-configuration-structure/main.go)
@@ -56,19 +55,27 @@
     * Custom Context
         * [Method Overriding](routing/custom-context/method-overriding/main.go)
         * [New Implementation](routing/custom-context/new-implementation/main.go)
-* Subdomains
-    * [Single](subdomains/single/main.go)
-    * [Multi](subdomains/multi/main.go)
-    * [Wildcard](subdomains/wildcard/main.go)
-    * [WWW](subdomains/www/main.go)
-    * [Redirection](subdomains/redirect/main.go)
-* API Versioning
-    * [How it works](https://github.com/kataras/iris/wiki/API-versioning)
-    * [Example](versioning/main.go)
+    * Subdomains
+        * [Single](routing/subdomains/single/main.go)
+        * [Multi](routing/subdomains/multi/main.go)
+        * [Wildcard](routing/subdomains/wildcard/main.go)
+        * [WWW](routing/subdomains/www/main.go)
+        * [Redirection](routing/subdomains/redirect/main.go)
+    * [HTTP Method Override](https://github.com/kataras/iris/blob/master/middleware/methodoverride/methodoverride_test.go)
+    * [API Versioning](routing/versioning/main.go)
+    * [Sitemap](routing/sitemap/main.go)
+* Logging
+    * [Request Logger](logging/request-logger/main.go)
+        * [Log Requests to a File](logging/request-logger/request-logger-file/main.go)
+        * [Log Requests to a JSON File](logging/request-logger/request-logger-file-json/main.go) 
+    * [Application File Logger](logging/file-logger/main.go)
+    * [Application JSON Logger](logging/json-logger/main.go)
 * API Documentation
-    * [yaag](apidoc/yaag/main.go)
-* Testing
-    * [Example](testing/httptest/main_test.go)
+    * [Yaag](apidoc/yaag/main.go)
+    * [Swagger](https://github.com/iris-contrib/swagger/tree/master/example)
+* [Testing](testing/httptest/main_test.go)
+* [Recovery](recover/main.go)
+* [Profiling](pprof/main.go)
 * File Server
     * [Favicon](file-server/favicon/main.go)
     * [Basic](file-server/basic/main.go)
@@ -79,6 +86,8 @@
         * [Basic SPA](file-server/single-page-application/basic/main.go)
         * [Embedded Single Page Application](file-server/single-page-application/embedded-single-page-application/main.go)
         * [Embedded Single Page Application with other routes](file-server/single-page-application/embedded-single-page-application-with-other-routes/main.go)
+    * [Upload File](file-server/upload-file/main.go)
+    * [Upload Multiple Files](file-server/upload-files/main.go)
 * View
     * [Overview](view/overview/main.go)
     * [Basic](view/template_html_0/main.go)
@@ -93,51 +102,51 @@
     * [Pug: `Actions`](view/template_pug_1)
     * [Pug: `Includes`](view/template_pug_2)
     * [Pug: `Extends`](view/template_pug_3)
-    * [Jet Template](/view/template_jet_0)
+    * [Jet Template](view/template_jet_0)
     * [Jet Embedded](view/template_jet_1_embedded)
-    * [Jet 'urlpath' tmpl func](/view/template_jet_2)
-    * [Jet Template Funcs from Struct](/view/template_jet_3)
+    * [Jet 'urlpath' tmpl func](view/template_jet_2)
+    * [Jet Template Funcs from Struct](view/template_jet_3)
     * Third-Parties
-        * [Render `valyala/quicktemplate` templates](http_responsewriter/quicktemplate)
-        * [Render `shiyanhui/hero` templates](http_responsewriter/herotemplate)
+        * [Render `valyala/quicktemplate` templates](view/quicktemplate)
+        * [Render `shiyanhui/hero` templates](view/herotemplate)
+* [Request ID](https://github.com/kataras/iris/blob/master/middleware/requestid/requestid_test.go)
+* [Request Rate Limit](request-ratelimit/main.go)
+* [Request Referrer](request-referrer/main.go)
+* [Webassembly](webassembly/basic/main.go)
 * Request Body
-    * [Bind JSON](http_request/read-json/main.go)
-    *   * [Struct Validation](http_request/read-json-struct-validation/main.go)
-    * [Bind XML](http_request/read-xml/main.go)
-    * [Bind MsgPack](http_request/read-msgpack/main.go)
-    * [Bind YAML](http_request/read-yaml/main.go)
-    * [Bind Form](http_request/read-form/main.go)
-    * [Bind Query](http_request/read-query/main.go)
-    * [Bind Body](http_request/read-body/main.go)
-    * [Bind Custom per type](http_request/read-custom-per-type/main.go)
-    * [Bind Custom via Unmarshaler](http_request/read-custom-via-unmarshaler/main.go)
-    * [Bind Many times](http_request/read-many/main.go)
-    * [Read/Bind Gzip compressed data](http_request/read-gzip/main.go)
-    * [Upload/Read File](http_request/upload-file/main.go)
-    * [Upload multiple Files](http_request/upload-files/main.go)
-    * [Extract Referrer](http_request/extract-referer/main.go)
+    * [Bind JSON](request-body/read-json/main.go)
+    *   * [Struct Validation](request-body/read-json-struct-validation/main.go)
+    * [Bind XML](request-body/read-xml/main.go)
+    * [Bind MsgPack](request-body/read-msgpack/main.go)
+    * [Bind YAML](request-body/read-yaml/main.go)
+    * [Bind Form](request-body/read-form/main.go)
+    * [Bind Query](request-body/read-query/main.go)
+    * [Bind Body](request-body/read-body/main.go)
+    * [Bind Custom per type](request-body/read-custom-per-type/main.go)
+    * [Bind Custom via Unmarshaler](request-body/read-custom-via-unmarshaler/main.go)
+    * [Bind Many times](request-body/read-many/main.go)
+    * [Read/Bind Gzip compressed data](request-body/read-gzip/main.go)
 * Response Writer
-    * [Content Negotiation](http_responsewriter/content-negotiation)
-    * [Text, Markdown, YAML, HTML, JSON, JSONP, Msgpack, XML and Binary](http_responsewriter/write-rest/main.go)
-    * [Write Gzip](http_responsewriter/write-gzip/main.go)
-    * [Stream Writer](http_responsewriter/stream-writer/main.go)
-    * [Transactions](http_responsewriter/transactions/main.go)
-    * [SSE](http_responsewriter/sse/main.go)
-    * [SSE (third-party package usage for server sent events)](http_responsewriter/sse-third-party/main.go)
-    * [Webassembly](webassembly/basic/main.go)
-* Cache
-    * [Simple](cache/simple/main.go)
-    * [Client-Side (304)](cache/client-side/main.go)
+    * [Content Negotiation](response-writer/content-negotiation)
+    * [Text, Markdown, YAML, HTML, JSON, JSONP, Msgpack, XML and Binary](response-writer/write-rest/main.go)
+    * [Write Gzip](response-writer/write-gzip/main.go)
+    * [Stream Writer](response-writer/stream-writer/main.go)
+    * [Transactions](response-writer/transactions/main.go)
+    * [SSE](response-writer/sse/main.go)
+    * [SSE (third-party package usage for server sent events)](response-writer/sse-third-party/main.go)
+    * Cache
+        * [Simple](response-writer/simple/main.go)
+        * [Client-Side (304)](response-writer/client-side/main.go)
 * Localization and Internationalization
     * [i18n](i18n/main.go)
-* Sitemaps
-    * [Sitemap](sitemap/main.go)
-* Authentication
-    * [Basic Authentication](authentication/basicauth/main.go)
-    * [JWT](miscellaneous/jwt/main.go)
-    * [JWT (community edition)](experimental-handlers/jwt/main.go)
-    * [OAUth2](authentication/oauth2/main.go)
-    * [Manage Permissions](permissions/main.go)
+* Authentication, Authorization & Bot Detection 
+    * [Basic Authentication](auth/basicauth/main.go)
+    * [JWT](auth/jwt/main.go)
+    * [JWT (community edition)](https://github.com/iris-contrib/middleware/tree/v12/jwt/_example/main.go)
+    * [OAUth2](auth/goth/main.go)
+    * [Manage Permissions](auth/permissions/main.go)
+    * [Google reCAPTCHA](auth/recaptcha/main.go)
+    * [hCaptcha](auth/hcaptcha/main.go)
 * Cookies
     * [Basic](cookies/basic/main.go)
     * [Options](cookies/options/main.go)
@@ -160,16 +169,17 @@
         * [Browser NPM Client (browserify)](websocket/basic/browserify/app.js)
     * [Native Messages](websocket/native-messages/main.go)
     * [TLS](websocket/secure/README.md)
+    * [Online Visitors](websocket/online-visitors/main.go)
 * Dependency Injection
     * [Overview (Movies Service)](ependency-injection/overview/main.go)
     * [Basic](dependency-injection/basic/main.go)
         * [Middleware](dependency-injection/basic/middleware/main.go)
     * [Sessions](dependency-injection/sessions/main.go)
     * [Smart Contract](dependency-injection/smart-contract/main.go)
     * [JWT](dependency-injection/jwt/main.go)
+        * [JWT (iris-contrib)](dependency-injection/jwt/contrib/main.go)
 * MVC
     * [Overview - Repository and Service layers](mvc/overview)
-    * [Login - Repository and Service layers](mvc/login)
     * [Hello world](mvc/hello-world/main.go)
     * [Basic](mvc/basic/main.go)
         * [Wildcard](mvc/basic/wildcard/main.go)
@@ -179,27 +189,13 @@
     * [Authenticated Controller](mvc/authenticated-controller/main.go)
     * [Websocket Controller](mvc/websocket)
     * [Register Middleware](mvc/middleware)
-* Object-Relational Mapping
-    * [Using `go-xorm/xorm` (Mysql, MyMysql, Postgres, Tidb, SQLite, MsSql, MsSql, Oracle)](orm/xorm/main.go)
-    * [Using `jinzhu/gorm`](orm/gorm/main.go)
-* Project Structure
-    * [Bootstrapper](structuring/bootstrap)
-    * [MVC with Repository and Service layer Overview](structuring/mvc-plus-repository-and-service-layers)
-    * [Login (MVC with Single Responsibility package)](structuring/login-mvc-single-responsibility-package)
-    * [Login (MVC with Datamodels, Datasource, Repository and Service layer)](structuring/login-mvc)
+    * [gRPC](mvc/grpc-compatible)
+    * [Login (Repository and Service layers)](mvc/login)
+    * [Login (Single Responsibility)](mvc/login-mvc-single-responsibility)
+    * [Vue.js Todo App](mvc/vuejs-todo-mvc)
+* [Bootstrapper](bootstrap)
 * Desktop Applications
-    * [The blink package](desktop-app/blink)
-    * [The lorca package](desktop-app/lorca)
-    * [The webview package](desktop-app/webview)
-* Middlewares (Builtin)
-    * [JWT](miscellaneous/jwt/main.go)
-    * [Rate Limit](miscellaneous/ratelimit/main.go)
-    * [HTTP Method Override](https://github.com/kataras/iris/blob/master/middleware/methodoverride/methodoverride_test.go)
-    * [Request Logger](http_request/request-logger/main.go)
-        * [Log Requests to a File](http_request/request-logger/request-logger-file/main.go)
-    * [Recovery](miscellaneous/recover/main.go)
-    * [Profiling (pprof)](miscellaneous/pprof/main.go)
-    * [Internal Application File Logger](miscellaneous/file-logger/main.go)
-    * [Google reCAPTCHA](miscellaneous/recaptcha/main.go)
-    * [hCaptcha](miscellaneous/hcaptcha/main.go)
+    * [The blink package](desktop/blink)
+    * [The lorca package](desktop/lorca)
+    * [The webview package](desktop/webview)
 * Middlewares [(Community)](https://github.com/iris-contrib/middleware)

_examples/apidoc/swagger/README.md

@@ -0,0 +1,3 @@
+# Swagger 2.0
+
+Visit https://github.com/iris-contrib/swagger instead.

_examples/authentication/oauth2/templates/index.html → _examples/auth/goth/templates/index.html

@@ -1,3 +1,3 @@
-{{range $key,$value:=.Providers}}
-    <p><a href="/auth/{{$value}}">Log in with {{index $.ProvidersMap $value}}</a></p>
+{{range $key,$value:=.Providers}}
+    <p><a href="/auth/{{$value}}">Log in with {{index $.ProvidersMap $value}}</a></p>
 {{end}}