iris/_examples/apidoc/yaag/main.go
Gerasimos (Makis) Maropoulos 0e2c44e231 fix embedded fs not access to dir list because of options.ShowList unnecessary check. Solves #1383
Former-commit-id: 1ad4535deb1c4792408a3bf63456b333aa752594
2019-10-25 01:04:08 +03:00

60 lines
1.4 KiB
Go

package main
import (
"github.com/kataras/iris"
"github.com/betacraft/yaag/irisyaag"
"github.com/betacraft/yaag/yaag"
)
/*
go get github.com/betacraft/yaag@v1.0.1-0.20190930134538-3ebbf33677d5
*/
type myXML struct {
Result string `xml:"result"`
}
func main() {
app := iris.New()
yaag.Init(&yaag.Config{ // <- IMPORTANT, init the middleware.
On: true,
DocTitle: "Iris",
DocPath: "apidoc.html",
BaseUrls: map[string]string{"Production": "", "Staging": ""},
})
app.Use(irisyaag.New()) // <- IMPORTANT, register the middleware.
app.Get("/json", func(ctx iris.Context) {
ctx.JSON(iris.Map{"result": "Hello World!"})
})
app.Get("/plain", func(ctx iris.Context) {
ctx.Text("Hello World!")
})
app.Get("/xml", func(ctx iris.Context) {
ctx.XML(myXML{Result: "Hello World!"})
})
app.Get("/complex", func(ctx iris.Context) {
value := ctx.URLParam("key")
ctx.JSON(iris.Map{"value": value})
})
// Run our HTTP Server.
//
// Documentation of "yaag" doesn't note the follow, but in Iris we are careful on what
// we provide to you.
//
// Each incoming request results on re-generation and update of the "apidoc.html" file.
// Recommentation:
// Write tests that calls those handlers, save the generated "apidoc.html".
// Turn off the yaag middleware when in production.
//
// Example usage:
// Visit all paths and open the generated "apidoc.html" file to see the API's automated docs.
app.Run(iris.Addr(":8080"))
}