iris/_examples/README.md

# Table of Contents <a href="./README_ZH_HANT.md"> <img width="20px" src="https://iris-go.com/images/flag-china.svg?v=10" /> </a>

* [Serverless](https://github.com/iris-contrib/gateway#netlify)
* [REST API for Apache Kafka](kafka-api)
* [URL Shortener](url-shortener)
* [Dropzone.js](dropzonejs)
* [Caddy](caddy)
* [Bootstrapper](bootstrapper)
* [Project Structure](project) :fire:
* Monitor
    * [Simple Process Monitor (includes UI)](monitor/monitor-middleware/main.go) **NEW**
    * [Heap, MSpan/MCache, Size Classes, Objects, Goroutines, GC/CPU fraction (includes UI)](monitor/statsviz/main.go) **NEW**
* Database
    * [MySQL, Groupcache & Docker](database/mysql)
    * [MongoDB](database/mongodb)
    * [Sqlx](database/orm/sqlx/main.go)
    * [Gorm](database/orm/gorm/main.go)
    * [Reform](database/orm/reform/main.go)
    * [x/sqlx](database/sqlx/main.go) **NEW**
* GraphQL
    * [GraphQL: schema-first](graphql/schema-first) **NEW**
* 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)
    * [Socket Sharding (SO_REUSEPORT)](http-server/socket-sharding/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-server/custom-listener/main.go)
    * Custom HTTP Server
        * [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)
        * [H2C](http-server/h2c/main.go) **NEW**
    * [Timeout](http-server/timeout/main.go)
* HTTP Client
    * [Weather Client](http-client/weatherapi)
* Configuration
    * [Functional](configuration/functional/main.go)
    * [Configuration Struct](configuration/from-configuration-structure/main.go)
    * [Using Viper](configuration/viper)
    * [Import from YAML](configuration/from-yaml-file/main.go)
        * [Share Configuration across instances](configuration/from-yaml-file/shared-configuration/main.go)
    * [Import from TOML](configuration/from-toml-file/main.go)
    * [Multi Environment Configuration](configuration/multi-environments) **NEW**
* Routing
    * [Party Controller](routing/party-controller) **NEW**
    * [Overview](routing/overview/main.go)
    * [Basic](routing/basic/main.go)
    * [Custom HTTP Errors](routing/http-errors/main.go)
    * [HTTP Wire Errors](routing/http-wire-errors/main.go) **NEW**
        * [Custom Validation Errors](routing/http-wire-errors/custom-validation-errors/main.go)
    * [Not Found - Intelligence](routing/intelligence/main.go)
        * [Not Found - Suggest Closest Paths](routing/intelligence/manual/main.go)
    * [Dynamic Path](routing/dynamic-path/main.go)
        * [At-username](routing/dynamic-path/at-username/main.go)
        * [Root Wildcard](routing/dynamic-path/root-wildcard/main.go)
        * [Implement a Parameter Type](routing/macros/main.go)
        * [Same Path Pattern but Func](routing/dynamic-path/same-pattern-different-func/main.go)
    * Middleware
        * [Per Route](routing/writing-a-middleware/per-route/main.go)
        * [Globally](routing/writing-a-middleware/globally/main.go)
        * [Remove a Handler](routing/remove-handler/main.go)
        * Share Values
            * [Share Services](routing/writing-a-middleware/share-services/main.go)
            * [Share Functions](routing/writing-a-middleware/share-funcs/main.go)
        * [Handlers Execution Rule](routing/route-handlers-execution-rules/main.go)
        * [Route Register Rule](routing/route-register-rule/main.go)
        * Convert net/http Handlers
            * [From func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)](convert-handlers/negroni-like/main.go)
            * [From http.Handler or http.HandlerFunc](convert-handlers/nethttp/main.go)
            * [From func(http.Handler) http.Handler](convert-handlers/wrapper/main.go)
            * [Convert by your own: sentry/raven middleware](convert-handlers/real-usecase-raven/writing-middleware/main.go)
    * [Rewrite Middleware](routing/rewrite/main.go)
    * [Route State](routing/route-state/main.go)
    * [Remove Route](routing/remove-route/main.go)
    * [Reverse Routing](routing/reverse/main.go)
    * [Router Wrapper](routing/custom-wrapper/main.go)
    * [Custom Router](routing/custom-router/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)
            * [WWW Method](routing/subdomains/www/www-method/main.go)
        * [Redirection](routing/subdomains/redirect/main.go)
            * [Multi Instances](routing/subdomains/redirect/multi-instances/main.go)
        * [HTTP Errors View](routing/subdomains/http-errors-view/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
    * [Application File Logger](logging/file-logger/main.go)
    * [Application JSON Logger](logging/json-logger/main.go)
    * [Rollbar](logging/rollbar/main.go)
    * AccessLog
        * [Log Requests to a JSON File](logging/request-logger/accesslog-simple/main.go)
        * [Using Log Rotation and more](logging/request-logger/accesslog)
        * [Custom Fields and Template](logging/request-logger/accesslog-template/main.go)
        * [Listen and render Logs to a Client](logging/request-logger/accesslog-broker/main.go)
        * [The CSV Formatter](logging/request-logger/accesslog-csv/main.go)
        * [Create your own Formatter](logging/request-logger/accesslog-formatter/main.go)
        * [Root and Proxy AccessLog instances](logging/request-logger/accesslog-proxy/main.go)
        * [Slack integration example](logging/request-logger/accesslog-slack/main.go)
* API Documentation
    * [Yaag](apidoc/yaag/main.go)
    * [Swagger](https://github.com/iris-contrib/swagger/tree/master/_examples/basic)
* Testing
    * [Testing with httptest](testing/httptest/main_test.go)
    * [Testing with ginkgo](testing/ginkgotest)
* [Recovery](recover/main.go)
    * [Panic and custom Error Handler with Compression](recover/panic-and-custom-error-handler-with-compression/main.go)
* [Profiling](pprof/main.go)
* File Server
    * [File Server](file-server/file-server/main.go)
    * [HTTP/2 Push Targets](file-server/http2push/main.go)
    * [HTTP/2 Push Targets (Embedded)](file-server/http2push-embedded/main.go)
    * [HTTP/2 Push Targets (Gzipped Embedded)](file-server/http2push-embedded-gzipped/main.go)
    * [Favicon](file-server/favicon/main.go)
    * [Basic](file-server/basic/main.go)
    * [Embedding Files Into App Executable File](file-server/embedding-files-into-app/main.go)
    * [Embedding Files Into App Executable File (Bindata)](file-server/embedding-files-into-app-bindata/main.go)
    * [Embedding Gzipped Files Into App Executable File (Bindata)](file-server/embedding-gzipped-files-into-app-bindata/main.go)
    * [Send Files (rate limiter included)](file-server/send-files/main.go)
    * Single Page Applications
        * [Vue Router](file-server/spa-vue-router)
        * [Basic SPA](file-server/single-page-application/basic/main.go)
        * [Embedded Single Page Application and `iris.PrefixDir`](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)
    * [WebDAV](file-server/webdav/main.go)
* View
    * [Overview](view/overview/main.go)
    * [Layout](view/layout)
        * [Ace](view/layout/ace)
        * [Blocks](view/layout/blocks)
        * [Django](view/layout/django)
        * [Handlebars](view/layout/handlebars)
        * [HTML](view/layout/html)
        * [Jet](view/layout/jet)
        * [Pug](view/layout/pug)
    * [Basic](view/template_html_0/main.go)
    * [A simple Layout](view/template_html_1/main.go)
    * [Layouts: `yield` and `render` tmpl funcs](view/template_html_2/main.go)
    * The `urlpath` template func
        * [HTML](view/template_html_3/main.go)
        * [Django](view/template_django_1/main.go)
    * [The `url` template func](view/template_html_4/main.go)
    * [Inject Data Between Handlers](view/context-view-data/main.go)
    * [Inject Engine Between Handlers](view/context-view-engine/main.go)
    * [Embedding Templates Into App Executable File](view/embedding-templates-into-app/main.go)
    * [Embedding Templates Into App Executable File (Bindata)](view/embedding-templates-into-app-bindata/main.go)
    * [Write to a custom `io.Writer`](view/write-to)
    * Parse a Template from Text
        * [HTML, Pug and Ace](view/parse-parse/main.go)
        * [Django](view/parse-parse/django/main.go)
        * [Jet](view/parse-parse/jet/main.go)
        * [Handlebars](view/parse-parse/handlebars/main.go)
    * [Blocks](view/template_blocks_0)
    * [Blocks Embedded](view/template_blocks_1_embedded)
    * [Pug: `Actions`](view/template_pug_0)
    * [Pug: `Includes`](view/template_pug_1)
    * [Pug Embedded`](view/template_pug_2_embedded)
    * [Ace](view/template_ace_0)
    * [Django](view/template_django_0)
    * [Jet](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)
    * [Handlebars](view/template_handlebars_0)
    * Third-Parties
        * [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/main.go)
* Request Body
    * [Bind JSON](request-body/read-json/main.go)
    *   * [JSON Stream and disable unknown fields](request-body/read-json-stream/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)
        * [Checkboxes](request-body/read-form/checkboxes/main.go)
    * [Bind Query](request-body/read-query/main.go)
    * [Bind Params](request-body/read-params/main.go)
    * [Bind URL](request-body/read-url/main.go)
    * [Bind Headers](request-body/read-headers/main.go)
    * [Bind Body](request-body/read-body/main.go)
    * [Add Converter](request-body/form-query-headers-params-decoder/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)
* Response Writer
    * [Content Negotiation](response-writer/content-negotiation)
    * [Text, Markdown, YAML, HTML, JSON, JSONP, Msgpack, XML and Binary](response-writer/write-rest/main.go)
    * [Third-party JSON Encoder](response-writer/json-third-party/main.go)
    * [Protocol Buffers](response-writer/protobuf/main.go)
    * [HTTP/2 Server Push](response-writer/http2push/main.go)
    * [Stream Writer](response-writer/stream-writer/main.go)
    * [Server-Sent Events](response-writer/sse/main.go)
        * [SSE 3rd-party (r3labs/sse)](response-writer/sse-third-party/main.go)
        * [SSE 3rd-party (alexandrevicenzi/go-sse)](response-writer/sse-third-party-2/main.go)
    * Cache
        * [Simple](response-writer/cache/simple/main.go)
        * [Client-Side (304)](response-writer/cache/client-side/main.go)
* Compression
    * [Server-Side](compression/main.go)
    * [Client-Side](compression/client/main.go)
    * [Client-Side (using Iris)](compress/client-using-iris/main.go)
* Localization and Internationalization
    * [Basic](i18n/basic)
    * [Ttemplates and Functions](i18n/template)
    * [Ttemplates and Functions (Embedded)](i18n/template-embedded)
    * [Pluralization and Variables](i18n/plurals)
* Authentication, Authorization & Bot Detection
    * [Recommended: Auth package and Single-Sign-On](auth/auth) **NEW (GO 1.18 Generics required)**
    * Basic Authentication
        * [Basic](auth/basicauth/basic)
        * [Load from a slice of Users](auth/basicauth/users_list)
        * [Load from a file & encrypted passwords](auth/basicauth/users_file_bcrypt)
        * [Fetch & validate a User from a Database (MySQL)](auth/basicauth/database)
    * [CORS](auth/cors)
    * JSON Web Tokens
        * [Basic](auth/jwt/basic/main.go)
        * [Middleware](auth/jwt/midleware/main.go)
        * [Blocklist](auth/jwt/blocklist/main.go)
        * [Refresh Token](auth/jwt/refresh-token/main.go)
        * [Tutorial](auth/jwt/tutorial)
    * [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)
    * [Encode/Decode (with `securecookie`)](cookies/securecookie/main.go)
* Sessions
    * [Overview: Config](sessions/overview/main.go)
        * [Overview: Routes](sessions/overview/example/example.go)
    * [Basic](sessions/basic/main.go)
    * [Secure Cookie](sessions/securecookie/main.go)
    * [Flash Messages](sessions/flash-messages/main.go)
    * [Databases](sessions/database)
        * [Badger](sessions/database/badger/main.go)
        * [BoltDB](sessions/database/boltdb/main.go)
        * [Redis](sessions/database/redis/main.go)
    * [View Data](sessions/viewdata)
* Websocket
    * [Gorilla FileWatch (3rd-party)](websocket/gorilla-filewatch/main.go)
    * [Basic](websocket/basic)
        * [Server](websocket/basic/server.go)
        * [Go Client](websocket/basic/go-client/client.go)
        * [Browser Client](websocket/basic/browser/index.html)
        * [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)
    * [Register Dependency from Context](dependency-injection/context-register-dependency/main.go)
* MVC
    * [Overview](mvc/overview)
    * [Repository and Service layers](mvc/repository)
    * [Hello world](mvc/hello-world/main.go)
    * [Basic](mvc/basic/main.go)
        * [Wildcard](mvc/basic/wildcard/main.go)
    * [Default request values](mvc/request-default-values/main.go)
    * [Singleton](mvc/singleton)
    * [Regexp](mvc/regexp/main.go)
    * [Session Controller](mvc/session-controller/main.go)
    * [Authenticated Controller](mvc/authenticated-controller/main.go)
    * [Versioned Controller](mvc/versioned-controller/main.go)
    * [Websocket Controller](mvc/websocket)
        * [Websocket + Authentication (Single-Sign-On)](mvc/websocket-auth) **NEW (GO 1.18 Generics required)**
    * [Register Middleware](mvc/middleware)
    * [gRPC](mvc/grpc-compatible)
    * [gRPC Bidirectional Stream](mvc/grpc-compatible-bidirectional-stream)
    * [Login (Repository and Service layers)](mvc/login)
    * [Login (Single Responsibility)](mvc/login-mvc-single-responsibility)
    * [Vue.js Todo App](mvc/vuejs-todo-mvc)
    * [HTTP Error Handler](mvc/error-handler-http)
    * [Error Handler](mvc/error-handler)
    * [Handle errors using mvc.Result](mvc/error-handler-custom-result)
    * [Handle errors using PreflightResult](mvc/error-handler-preflight)
    * [Handle errors by hijacking the result](mvc/error-handler-hijack)
* Desktop Applications
    * [The blink package](desktop/blink)
    * [The lorca package](desktop/lorca)
    * [The webview package](desktop/webview)
* Middlewares [(Community)](https://github.com/iris-contrib/middleware)