Skip to content

use knife4j-front to show the api documents for iris

License

Notifications You must be signed in to change notification settings

sin3degrees/knife4g

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Knife4g

use knife4j-front to show the api documents for iris

Usage

  1. Add comments to your API source code
  2. Download Swag for Go by using:
  3. Run swag init -ot json in your project directory
  4. Run go get github.com/sin3degrees/knife4g
  5. Add router to your iris project

    example:

    package main
    
    import (
        "github.com/kataras/iris/v12"
        "github.com/sin3degrees/knife4g"
    )
    
    func main() {
        engine := iris.Default()
        engine.Get("/doc/*any", knife4g.Handler(knife4g.Config{RelativePath: "/doc", SwaggerVersion: "2.0"}))
        engine.Run(":80")
    }
  6. Visit http://localhost/doc/index

Acknowledgement

Thanks to knife4j Thanks to knife4g

About

use knife4j-front to show the api documents for iris

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 100.0%