swagger_plugin

Documentation

Index

• func NewConfig(config Config) bean.Bean
• type Config
• type Contact
• type DynamicResult
• type Info
• type License
• type Starter
  • func NewStarter() *Starter
  • func (r *Starter) Controller() string
  • func (r *Starter) OpenAPI(req *http.Request, w http.ResponseWriter)
  • func (r *Starter) Static() string
  • func (r *Starter) Ui() resp.Response
• type SwaggerConfig

Functions

func NewConfig

func NewConfig(config Config) bean.Bean

Types

type Config

type Config struct {
	Info
	BasePath string   `json:"base_path"`
	Host     string   `json:"host"`
	Schemes  []string `json:"schemes"`
}

type Contact

type Contact struct {
	Email string `json:"email,omitempty"`
}

type DynamicResult

type DynamicResult struct{}

type Info

type Info struct {
	Description    string  `json:"description,omitempty"`
	Version        string  `json:"version,omitempty"`
	TermsOfService string  `json:"termsOfService,omitempty"`
	Title          string  `json:"title,omitempty"`
	Contact        Contact `json:"contact"`
	License        License `json:"license"`
}

type License

type License struct {
	Name string `json:"name,omitempty"`
	URL  string `json:"url,omitempty"`
}

type Starter

type Starter struct {
	bean.Component
	AppName string `value:"application.app_name"`

	Conf        *SwaggerConfig `bean:"swagger_config"`
	Controllers []component.Controller
	// contains filtered or unexported fields
}

func NewStarter

func NewStarter() *Starter

func (*Starter) Controller

func (r *Starter) Controller() string

func (*Starter) OpenAPI

func (r *Starter) OpenAPI(req *http.Request, w http.ResponseWriter)

func (*Starter) Static

func (r *Starter) Static() string

func (*Starter) Ui

func (r *Starter) Ui() resp.Response

type SwaggerConfig

type SwaggerConfig struct {
	bean.Component
	Config
}