knife4g's Introduction

Knife4g

use knife4j-front to show the api documents for gin

Usage

Add comments to your API source code
Download Swag for Go by using:
Run swag init -ot json in your project directory
Run go get github.com/hononet639/knife4g

Add router to your gin project

example:

package main

import (
    "github.com/gin-gonic/gin"
    "github.com/hononet639/knife4g"
)

func main() {
    engine := gin.Default()
    engine.GET("/doc/*any", knife4g.Handler(knife4g.Config{RelativePath: "/doc"}))
    engine.Run(":80")
}

Visit http://localhost/doc/index

Acknowledgement

Thanks to knife4j

knife4g's People

Contributors

Stargazers

Watchers

knife4g's Issues

路径问题

go get之后，
这个函数的./docs/swagger.json相对路径不生效，读出来是nil
func init() {
var err error
docJson, err = os.ReadFile("./docs/swagger.json")
if err != nil {
log.Println("no swagger.json found in ./docs")
}
}

multi module project docs path not found

For a multi module project, run the above command to generate the docs into a sub module. You need to copy to an external module to access it

====== no =======
demo
　├─srv1
　│ 　 └─main
　│　　　　└─docs
　└─srv2
　　　└─main

====== ok =======

demo
　├─srv1
　│ 　└─main
　├─srv2
　│ 　└─main
　└─docs

knife4g for iris

https://github.com/sin3degrees/knife4g
This is the project I forked from you, and I changed it to use for iris framework, please see if you can integrate it with yours

Recommend Projects