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

API 生成步骤

  • 下载YAAG中间件

go get github.com/betacraft/yaag/…

  • 导入依赖包

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

  • 初始化yaag

yaag.Init(&yaag.Config(On: true, DocTile: "Iris", DocPath: "apidoc.html"))

  • 注册yaag中间件

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

目录结构

主目录iris

  1.     —— apidoc.html (执行命令后生成)
  2.     —— apidoc.html.json (执行命令后生成)
  3.     —— main.go

代码示例

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. */
  12. type myXML struct {
  13.     Result string `xml:"result"`
  14. }
  16. func main() {
  17.     app := iris.New()
  18.     //初始化中间件
  19.     yaag.Init(&yaag.Config{
  20.         On:       true,                 //是否开启自动生成API文档功能
  21.         DocTitle: "Iris",
  22.         DocPath:  "apidoc.html",        //生成API文档名称存放路径
  23.         BaseUrls: map[string]string{"Production": "", "Staging": ""},
  24.     })
  25.     //注册中间件
  26.     app.Use(irisyaag.New())
  27.     app.Get("/json", func(ctx iris.Context) {
  28.         ctx.JSON(iris.Map{"result": "Hello World!"})
  29.     })
  30.     app.Get("/plain", func(ctx iris.Context) {
  31.         ctx.Text("Hello World!")
  32.     })
  33.     app.Get("/xml", func(ctx iris.Context) {
  34.         ctx.XML(myXML{Result: "Hello World!"})
  35.     })
  36.     app.Get("/complex", func(ctx iris.Context) {
  37.         value := ctx.URLParam("key")
  38.         ctx.JSON(iris.Map{"value": value})
  39.     })
  40.     //运行HTTP服务器。
  41.     //每个传入的请求都会重新生成和更新“apidoc.html”文件。
  43.     //编写调用这些处理程序的测试，保存生成的apidoc.html，apidoc.html.json。
  44.     //在制作时关闭yaag中间件。
  45.     app.Run(iris.Addr(":8080"))
  46. }

提示

  • 运行上面的例子，并请求其中任意一个接口，会生成apidoc.html，apidoc.html.json两个文件
  • 如果不关闭yaag中间件，apidoc.html，apidoc.html.json文件会随着每一次请求而重新生成
  • 如果没有翻墙，可能看不到生成效果，因为apidoc.html文件的引入了很多谷歌的cnd,替换成功国内支持即可