restfulx

README

chassix-restful

c5x.io/restful

Documentation

Index

• Constants
• func AddJwtAuth(ws *restful.WebService, ff restful.FilterFunction)
• func AddMetaDataTags(ws *restful.WebService, tags []string)
• func Serve(container *restful.Container, servIndex int)
• func ServeDefault()
• type OAISecurity
  • func (s *OAISecurity) Valid() error
• type OpenAPIConfig
• type OpenapiTagConfig
• type OpenapiUIConfig
• type RestfulConfig
• type ServerConfig

Constants

const (
	// KeyOpenAPITags is a Metadata key for a restful Route
	KeyOpenAPITags        = restfulSpec.KeyOpenAPITags
	SecurityDefinitionKey = "OAPI_SECURITY_DEFINITION"
)

Functions

func AddJwtAuth

func AddJwtAuth(ws *restful.WebService, ff restful.FilterFunction)

AddJwtAuth add metadata tags to Webservice all routes

func AddMetaDataTags

func AddMetaDataTags(ws *restful.WebService, tags []string)

AddMetaDataTags add metadata tags to Webservice all routes

func Serve

func Serve(container *restful.Container, servIndex int)

Serve rest webservice index start from 1 func Serve(svc []*restful.WebService) {

func ServeDefault

func ServeDefault()

ServeDefault serve with default container and first server config

Types

type OAISecurity

type OAISecurity struct {
	Name   string   // SecurityDefinition name
	Scopes []string // Scopes for oauth2
}

func (*OAISecurity) Valid

func (s *OAISecurity) Valid() error

type OpenAPIConfig

type OpenAPIConfig struct {
	Enabled  bool     `yaml:"enabled"`
	Host     string   `yaml:"host"`
	BasePath string   `yaml:"base_path"`
	Schemas  []string `yaml:"schemas"`
	Auth     string
	Spec     struct {
		Title       string
		Description string `yaml:"desc"`
		Contact     struct {
			Name  string
			Email string
			URL   string
		} `yaml:"contact"`
		License struct {
			Name string
			URL  string
		} `yaml:"license"`
		Version string
	}
	Tags []OpenapiTagConfig `yaml:",flow"`
	UI   OpenapiUIConfig    `yaml:"ui"`
}

OpenAPIConfig open api config

type OpenapiTagConfig

type OpenapiTagConfig struct {
	Name        string
	Description string `yaml:"desc"`
}

OpenapiTagConfig openapi tag

type OpenapiUIConfig

type OpenapiUIConfig struct {
	API        string `yaml:"api"`
	Dist       string `yaml:"dist"`
	Entrypoint string `yaml:"entrypoint"`
	External   string `yaml:"external"`
}

OpenapiUIConfig swagger ui config

type RestfulConfig

type RestfulConfig struct {
	OpenAPI OpenAPIConfig  `yaml:"openapi"`
	Servers []ServerConfig `yaml:"servers"`
}

type ServerConfig

type ServerConfig struct {
	Name        string
	Addr        string
	Description string
	OpenAPI     OpenAPIConfig `yaml:"openapi"`
}

ServerConfig