YAAG生成iris web框架项目API文档

    • 下载中间件
    • 导入依赖包

    import github.com/betacraft/yaag/yaagImport github.com/betacraft/yaag/irisyaag

    • 初始化yaag
    • 注册yaag中间件

    app.Use(irisyaag.New())irisyaag记录响应主体并向apidoc提供所有必要的信息

    main.go

    1. package main
    3. import (
    4.     "github.com/kataras/iris"
    6.     "github.com/betacraft/yaag/irisyaag"
    7.     "github.com/betacraft/yaag/yaag"
    8. )
    9. /*
    10.     下载包 go get github.com/betacraft/yaag/...
    11. type myXML struct {
    12.     Result string `xml:"result"`
    13. }
    15. func main() {
    16.     app := iris.New()
    17.     //初始化中间件
    18.     yaag.Init(&yaag.Config{
    19.         On:       true,                 //是否开启自动生成API文档功能
    20.         DocTitle: "Iris",
    21.         DocPath:  "apidoc.html",        //生成API文档名称存放路径
    22.         BaseUrls: map[string]string{"Production": "", "Staging": ""},
    23.     })
    24.     //注册中间件
    25.     app.Use(irisyaag.New())
    26.     app.Get("/json", func(ctx iris.Context) {
    27.         ctx.JSON(iris.Map{"result": "Hello World!"})
    28.     })
    29.         ctx.Text("Hello World!")
    30.     })
    31.     app.Get("/xml", func(ctx iris.Context) {
    33.     })
    34.     app.Get("/complex", func(ctx iris.Context) {
    35.         value := ctx.URLParam("key")
    36.         ctx.JSON(iris.Map{"value": value})
    37.     })
    38.     //运行HTTP服务器。
    39.     //每个传入的请求都会重新生成和更新“apidoc.html”文件。
    41.     //编写调用这些处理程序的测试，保存生成的apidoc.html，apidoc.html.json。
    42.     //在制作时关闭yaag中间件。
    43.     app.Run(iris.Addr(":8080"))
    44. }
    • 运行上面的例子，并请求其中任意一个接口，会生成apidoc.html，apidoc.html.json两个文件
    • 如果不关闭yaag中间件，apidoc.html，apidoc.html.json文件会随着每一次请求而重新生成