swagen

Documentation

Index

• func BuildSchemaValidation(schema *openapi3.SchemaRef, validationString string, fieldInterface string)
• func GenerateAndOutputSpec(config *definitions.OpenAPIGeneratorConfig, ...) error
• 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 GetArrayItemType(fieldType string) string
• func GetTagValue(tagStr string, tagName string, defaultValue string) string
• func HttpStatusCodeToString(httpStatusCode external.HttpStatusCode) string
• func InterfaceToSchemaRef(openapi *openapi3.T, interfaceType string) *openapi3.SchemaRef
• func IsDeprecated(deprecationOptions *definitions.DeprecationOptions) bool
• func IsFieldRequired(validationString string) bool
• func IsHiddenAsset(hideOptions *definitions.MethodHideOptions) bool
• func IsMapObject(typeName string) bool
• func IsPrimitiveType(typeName string) bool
• func IsSecurityNameInSecuritySchemes(securitySchemes []definitions.SecuritySchemeConfig, securityName string) bool
• func ParseBool(value string) *bool
• func ParseInteger(value string) *uint64
• func ParseNumber(value string) *float64
• func ToOpenApiSchema(typeName string) *openapi3.Schema
• func ToOpenApiSchemaRef(typeName string) *openapi3.SchemaRef
• func ToOpenApiType(typeName string) string
• type SchemaRefMap

Functions

func BuildSchemaValidation

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

func GenerateAndOutputSpec

func GenerateAndOutputSpec(config *definitions.OpenAPIGeneratorConfig, defs []definitions.ControllerMetadata, models []definitions.ModelMetadata, hasAnyErrorTypes bool) error

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, hasAnyErrorTypes bool) ([]byte, error)

GenerateSpec generates the OpenAPI specification

func GetArrayItemType

func GetArrayItemType(fieldType string) string

Helper function to determine the item type of an array

func GetTagValue

func GetTagValue(tagStr string, tagName string, defaultValue string) string

GetTagValue extracts the value for a specific tag name from a struct tag string If the tag or value is not found, returns the default value Example usage:

tag := `json:"houseNumber" validate:"gte=1"`
jsonValue := GetTagValue(tag, "json", "default") // returns "houseNumber"
validateValue := GetTagValue(tag, "validate", "default") // returns "gte=1"

func HttpStatusCodeToString

func HttpStatusCodeToString(httpStatusCode external.HttpStatusCode) string

func InterfaceToSchemaRef

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

func IsDeprecated

func IsDeprecated(deprecationOptions *definitions.DeprecationOptions) bool

func IsFieldRequired

func IsFieldRequired(validationString string) bool

func IsHiddenAsset

func IsHiddenAsset(hideOptions *definitions.MethodHideOptions) bool

func IsMapObject

func IsMapObject(typeName string) bool

func IsPrimitiveType

func IsPrimitiveType(typeName string) bool

func IsSecurityNameInSecuritySchemes

func IsSecurityNameInSecuritySchemes(securitySchemes []definitions.SecuritySchemeConfig, securityName string) bool

func ParseBool

func ParseBool(value string) *bool

Helper function to parse boolean validation values

func ParseInteger

func ParseInteger(value string) *uint64

Helper function to parse integer validation values

func ParseNumber

func ParseNumber(value string) *float64

Helper function to parse numeric validation values

func ToOpenApiSchema

func ToOpenApiSchema(typeName string) *openapi3.Schema

func ToOpenApiSchemaRef

func ToOpenApiSchemaRef(typeName string) *openapi3.SchemaRef

func ToOpenApiType

func ToOpenApiType(typeName string) string

Types

type SchemaRefMap

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