Documentation
¶
Overview ¶
dynaswag/schema.go
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Register ¶
func Register(opts ...RegisterOption)
Types ¶
type APIEndpoint ¶
type Generator ¶
type Generator struct {
// contains filtered or unexported fields
}
func NewGenerator ¶
func (*Generator) AddAPI ¶
func (g *Generator) AddAPI(api APIEndpoint) *Generator
func (*Generator) GenerateTemplate ¶
type Parameter ¶
type Parameter struct {
Name string `json:"name"`
In string `json:"in"`
Description string `json:"description,omitempty"`
Required bool `json:"required"`
Type string `json:"type,omitempty"`
Format string `json:"format,omitempty"`
Schema interface{} `json:"schema,omitempty"`
Enum []string `json:"enum,omitempty"`
}
type RegisterOption ¶
type RegisterOption func(*Generator)
func WithApiEndpoint ¶
func WithApiEndpoint(api ...APIEndpoint) RegisterOption
func WithBasePath ¶
func WithBasePath(basePath string) RegisterOption
func WithHost ¶
func WithHost(host string) RegisterOption
func WithScheme ¶
func WithScheme(schemes ...string) RegisterOption
func WithTitle ¶
func WithTitle(title string) RegisterOption
func WithVersion ¶
func WithVersion(version string) RegisterOption
type StructParams ¶
func ParseParameters ¶
func ParseParameters(req any) *StructParams
Click to show internal directories.
Click to hide internal directories.