go-packages/iris
1
0
Fork 0
mirror of https://github.com/kataras/iris.git synced 2025-02-09 02:34:55 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

add some more examples and screenshots about hero funcs on README.md

Browse Source 
Former-commit-id: 2703036228ec896edcffe322964e85680be09d23
This commit is contained in:
Gerasimos (Makis) Maropoulos 2018-08-08 14:58:37 +03:00
parent 01d5578c7f
commit 0491aa68b5
1 changed files with 36 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -87,6 +87,30 @@ func main() {
$ go run example.go $ go run example.go
``` ```
## Dependency Injection
The package [hero](hero) contains features for binding any object or functions that `handlers` can use, these are called dependencies.
With Iris you get truly safe bindings thanks to the [hero](_examples/hero) [package](hero). It is blazing-fast, near to raw handlers performance because Iris calculates everything before even server goes online!
Below you will see some screenshots I prepared for you in order to be easier to understand:
### 1. Path Parameters - Built'n Dependencies
![](https://github.com/kataras/explore/raw/master/iris/hero/hero-1-monokai.png)
### 2. Services - Static Dependencies
![](https://github.com/kataras/explore/raw/master/iris/hero/hero-2-monokai.png)
### 3. Per-Request - Dynamic Dependencies
![](https://github.com/kataras/explore/raw/master/iris/hero/hero-3-monokai.png)
`hero funcs` are very easy to understand and when you start using them **you never go back**.
> With Iris you also get real and [blazing-fast](_benchmarks) [MVC support](_examples/mvc) which uses "hero" under the hoods.
## API Examples ## API Examples
### Using Get, Post, Put, Patch, Delete and Options ### Using Get, Post, Put, Patch, Delete and Options
@ -451,9 +475,12 @@ func main() {
// Navigate to http://localhost:8080/ping // Navigate to http://localhost:8080/ping
// and open the ./logs{TODAY}.txt file. // and open the ./logs{TODAY}.txt file.
if err := app.Run(iris.Addr(":8080"), iris.WithoutBanner, iris.WithoutServerError(iris.ErrServerClosed)); err != nil { app.Run(
app.Logger().Warn("Shutdown with error: " + err.Error()) iris.Addr(":8080"),
} iris.WithoutBanner,
iris.WithoutVersionChecker,
iris.WithoutServerError(iris.ErrServerClosed),
)
} }
``` ```
@ -613,11 +640,12 @@ func setupWebsocket(app *iris.Application) {
ws.OnConnection(handleConnection) ws.OnConnection(handleConnection)
// register the server on an endpoint. // register the server on an endpoint.
// see the inline javascript code in the websockets.html, this endpoint is used to connect to the server. // see the inline javascript code in the websockets.html,
// this endpoint is used to connect to the server.
app.Get("/echo", ws.Handler()) app.Get("/echo", ws.Handler())
// serve the javascript built'n client-side library, // serve the javascript built'n client-side library,
// see websockets.html script tags, this path is used. // see websockets.html script tags, this path is used.
app.Any("/iris-ws.js",websocket.ClientHandler()) app.Any("/iris-ws.js", websocket.ClientHandler())
} }
func handleConnection(c websocket.Connection) { func handleConnection(c websocket.Connection) {
@ -639,7 +667,8 @@ func handleConnection(c websocket.Connection) {
<!-- the message's input --> <!-- the message's input -->
<input id="input" type="text" /> <input id="input" type="text" />
<!-- when clicked then an iris websocket event will be sent to the server, at this example we registered the 'chat' --> <!-- when clicked then an iris websocket event will be sent to the server,
at this example we registered the 'chat' -->
<button onclick="send()">Send</button> <button onclick="send()">Send</button>
<!-- the messages will be shown here --> <!-- the messages will be shown here -->
@ -673,7 +702,7 @@ func handleConnection(c websocket.Connection) {
function send() { function send() {
addMessage("Me: " + input.value); // write ourselves addMessage("Me: " + input.value); // write ourselves
socket.Emit("chat", input.value);// send chat event data to the websocket server socket.Emit("chat", input.value); // send chat event data to the websocket server
input.value = ""; // clear the input input.value = ""; // clear the input
} }