You've already forked golang-base-project
Initial commit
This commit is contained in:
61
vendor/github.com/swaggo/swag/swagger.go
generated
vendored
Normal file
61
vendor/github.com/swaggo/swag/swagger.go
generated
vendored
Normal file
@ -0,0 +1,61 @@
|
||||
package swag
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"sync"
|
||||
)
|
||||
|
||||
// Name is a unique name be used to register swag instance.
|
||||
const Name = "swagger"
|
||||
|
||||
var (
|
||||
swaggerMu sync.RWMutex
|
||||
swags map[string]Swagger
|
||||
)
|
||||
|
||||
// Swagger is a interface to read swagger document.
|
||||
type Swagger interface {
|
||||
ReadDoc() string
|
||||
}
|
||||
|
||||
// Register registers swagger for given name.
|
||||
func Register(name string, swagger Swagger) {
|
||||
swaggerMu.Lock()
|
||||
defer swaggerMu.Unlock()
|
||||
if swagger == nil {
|
||||
panic("swagger is nil")
|
||||
}
|
||||
|
||||
if swags == nil {
|
||||
swags = make(map[string]Swagger)
|
||||
}
|
||||
|
||||
if _, ok := swags[name]; ok {
|
||||
panic("Register called twice for swag: " + name)
|
||||
}
|
||||
swags[name] = swagger
|
||||
}
|
||||
|
||||
// ReadDoc reads swagger document. An optional name parameter can be passed to read a specific document.
|
||||
// The default name is "swagger".
|
||||
func ReadDoc(optionalName ...string) (string, error) {
|
||||
swaggerMu.RLock()
|
||||
defer swaggerMu.RUnlock()
|
||||
|
||||
if swags == nil {
|
||||
return "", errors.New("no swag has yet been registered")
|
||||
}
|
||||
|
||||
name := Name
|
||||
if len(optionalName) != 0 && optionalName[0] != "" {
|
||||
name = optionalName[0]
|
||||
}
|
||||
|
||||
swag, ok := swags[name]
|
||||
if !ok {
|
||||
return "", fmt.Errorf("no swag named \"%s\" was registered", name)
|
||||
}
|
||||
|
||||
return swag.ReadDoc(), nil
|
||||
}
|
Reference in New Issue
Block a user