knife4go

package module

v1.0.4 Latest Latest Go to latest Published: Jun 28, 2023 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/go-webtools/knife4go

Links

Open Source Insights

README ¶

knife4go

simply Assembled knife4j + gin-swagger, it means an enhanced version of gin-swagger with nice UI.

work well on go1.18+

go get

go get github.com/go-webtools/knife4go

usage

Based on the usage of gin-swagger, add sth as follows:

import (
	knife4goGin "github.com/go-webtools/knife4go/gin"
	knife4goFiles "github.com/go-webtools/knife4go"
    ...
	swaggerFiles "github.com/swaggo/files"     // swagger embed files
	ginSwagger "github.com/swaggo/gin-swagger" // gin-swagger middleware
)

func InitRouters() *gin.Engine {
    	router := gin.Default()
	// swagger base router
	router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
	// knife4go: beautify swagger-ui
	router.GET("/knife4go/*any", knife4goGin.WrapHandler(knife4goFiles.Handler))
    ...
}

Disclaimer

Public welfare projects.
The disclaimer asserts that the individual won't be held responsible for any. LICENSE

Links

gin-swagger: https://github.com/swaggo/gin-swagger
knife4j: https://github.com/xiaoymin/knife4j
swag: https://github.com/swaggo/swag/cmd/swag

Documentation ¶

Index ¶

Variables
func ReadFile(path string) ([]byte, error)
func WalkDirs(name string, includeDirsInList bool, files ...string) ([]string, error)
func WriteFile(filename string, data []byte, perm os.FileMode) error
type HTTPFS
- func (hfs *HTTPFS) Open(path string) (http.File, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// CTX is a context for webdav vfs
	CTX = context.Background()

	// FS is a virtual memory file system
	FS = webdav.NewMemFS()

	// Handler is used to server files through a http handler
	Handler *webdav.Handler

	// HTTP is the http file system
	HTTP http.FileSystem = new(HTTPFS)
)

Functions ¶

func ReadFile ¶

func ReadFile(path string) ([]byte, error)

ReadFile is adapTed from ioutil

func WalkDirs ¶

func WalkDirs(name string, includeDirsInList bool, files ...string) ([]string, error)

WalkDirs looks for files in the given dir and returns a list of files in it usage for all files in the b0x: WalkDirs("", false)

func WriteFile ¶

func WriteFile(filename string, data []byte, perm os.FileMode) error

WriteFile is adapTed from ioutil

Types ¶

type HTTPFS ¶

type HTTPFS struct {
	// Prefix allows to limit the path of all requests. F.e. a prefix "css" would allow only calls to /css/*
	Prefix string
}

HTTPFS implements http.FileSystem

func (*HTTPFS) Open ¶

func (hfs *HTTPFS) Open(path string) (http.File, error)

Open a file

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
gin

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL