swagen30

Documentation

Index

• func BuildSchemaValidation(schema *openapi3.SchemaRef, validationString string, fieldInterface string)
• func GenerateControllersSpec(openapi *openapi3.T, config *definitions.OpenAPIGeneratorConfig, ...) error
• func GenerateModelsSpec(openapi *openapi3.T, models []definitions.ModelMetadata) error
• func GenerateSecuritySpec(openapi *openapi3.T, securityConfig *[]definitions.SecuritySchemeConfig) error
• func GenerateSpec(config *definitions.OpenAPIGeneratorConfig, ...) ([]byte, error)
• func InterfaceToSchemaRef(openapi *openapi3.T, interfaceType string) *openapi3.SchemaRef
• func ToOpenApiSchema(typeName string) *openapi3.Schema
• func ToOpenApiSchemaRef(typeName string) *openapi3.SchemaRef
• type SchemaRefMap

Functions

func BuildSchemaValidation

func BuildSchemaValidation(schema *openapi3.SchemaRef, validationString string, fieldInterface string)

func GenerateControllersSpec

func GenerateControllersSpec(openapi *openapi3.T, config *definitions.OpenAPIGeneratorConfig, defs []definitions.ControllerMetadata) error

func GenerateModelsSpec

func GenerateModelsSpec(openapi *openapi3.T, models []definitions.ModelMetadata) error

func GenerateSecuritySpec

func GenerateSecuritySpec(openapi *openapi3.T, securityConfig *[]definitions.SecuritySchemeConfig) error

func GenerateSpec

func GenerateSpec(config *definitions.OpenAPIGeneratorConfig, defs []definitions.ControllerMetadata, models []definitions.ModelMetadata) ([]byte, error)

GenerateSpec generates the OpenAPI specification

func InterfaceToSchemaRef

func InterfaceToSchemaRef(openapi *openapi3.T, interfaceType string) *openapi3.SchemaRef

func ToOpenApiSchema

func ToOpenApiSchema(typeName string) *openapi3.Schema

func ToOpenApiSchemaRef

func ToOpenApiSchemaRef(typeName string) *openapi3.SchemaRef

Types

type SchemaRefMap

type SchemaRefMap struct {
	InterfaceType string
	SchemaRef     *openapi3.SchemaRef
}