Documentation
¶
Index ¶
- func DeserializeFromYaml(file []byte) (map[string]any, error)
- type BuildParameter
- type Components
- type Contact
- type FactoryCollection
- func (b *FactoryCollection) Make() (*collection.Collection, *context.Context, []action.Request, error)
- func (b *FactoryCollection) MakeFromOperation(method domain.HttpMethod, path string, operation *Operation, ...) (*context.Context, *action.Request)
- func (b *FactoryCollection) MakeFromParameters(path string, parameters []Parameter, ctx *context.Context) (string, *context.Context, *query.Queries, *header.Headers, ...)
- func (b *FactoryCollection) MakeFromRequestBody(requestBody *RequestBody) *body.BodyRequest
- func (b *FactoryCollection) MakeFromSchema(content string, schema *Schema, visited map[string]int) (map[string]BuildParameter, map[string]int)
- func (b *FactoryCollection) MakeFromSecurity(security []SecurityRequirement, queries *header.Headers) *auth.Auths
- func (b *FactoryCollection) SetRaw(raw map[string]any) *FactoryCollection
- type Info
- type MediaType
- type OpenAPI
- type Operation
- type Parameter
- type PathItem
- type RequestBody
- type Response
- type Schema
- type SecurityRequirement
- type SecurityScheme
- type Server
- type Tag
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type BuildParameter ¶
type BuildParameter struct {
Value string
Children *map[string]BuildParameter
Vector bool
Binary bool
}
type Components ¶
type Components struct {
Schemas map[string]Schema `json:"schemas"`
SecuritySchemes map[string]SecurityScheme `json:"securitySchemes"`
RequestBodies map[string]RequestBody `json:"requestBodies"`
}
type FactoryCollection ¶
type FactoryCollection struct {
// contains filtered or unexported fields
}
func NewFactoryCollection ¶
func NewFactoryCollection(owner string, openapi *OpenAPI) *FactoryCollection
func (*FactoryCollection) Make ¶
func (b *FactoryCollection) Make() (*collection.Collection, *context.Context, []action.Request, error)
func (*FactoryCollection) MakeFromOperation ¶
func (*FactoryCollection) MakeFromParameters ¶
func (*FactoryCollection) MakeFromRequestBody ¶
func (b *FactoryCollection) MakeFromRequestBody(requestBody *RequestBody) *body.BodyRequest
func (*FactoryCollection) MakeFromSchema ¶
func (b *FactoryCollection) MakeFromSchema(content string, schema *Schema, visited map[string]int) (map[string]BuildParameter, map[string]int)
func (*FactoryCollection) MakeFromSecurity ¶
func (b *FactoryCollection) MakeFromSecurity(security []SecurityRequirement, queries *header.Headers) *auth.Auths
func (*FactoryCollection) SetRaw ¶
func (b *FactoryCollection) SetRaw(raw map[string]any) *FactoryCollection
type OpenAPI ¶
type OpenAPI struct {
OpenAPI string `json:"openapi"`
Info Info `json:"info"`
Servers []Server `json:"servers"`
Paths map[string]PathItem `json:"paths"`
Components Components `json:"components"`
Security []SecurityRequirement `json:"security"`
Tags []Tag `json:"tags"`
}
type Operation ¶
type Operation struct {
Tags []string `json:"tags"`
Summary string `json:"summary"`
Description string `json:"description"`
Parameters []Parameter `json:"parameters,omitempty"`
RequestBody *RequestBody `json:"requestBody,omitempty"`
Responses map[string]Response `json:"responses"`
Security []SecurityRequirement `json:"security,omitempty"`
}
type RequestBody ¶
type SecurityRequirement ¶
type SecurityScheme ¶
Click to show internal directories.
Click to hide internal directories.