internal/

Feb 2, 2025

Changes in this version

+ const NULL

+ const ParameterInHeader

+ const ParameterInPath

+ const ParameterInQuery

+ const RootOpenAPIName

+ const RootServiceName

+ const TypeArray

+ const TypeBoolean

+ const TypeInteger

+ const TypeNumber

+ const TypeObject

+ const TypeString

+ var ErrGettingFileFromURL = errors.New("error getting file from url")

+ var ErrUnexpectedFormDataType = errors.New("expected map[string]any for multipart/form-data")

+ var ErrUnexpectedFormURLEncodedType = errors.New("expected map[string]any for x-www-form-urlencoded")

+ var Fakes = GetFakes()

+ var Replacers = []Replacer

+ var TestDataPath = filepath.Join(filepath.Dir(b), "..", "testdata")

+ func ApplySchemaConstraints(openAPISchema any, res any) any

+ func CastToSchemaFormat(ctx *ReplaceContext, value any) any

+ func CleanupServiceFileStructure(servicePath string) error

+ func CollectContexts(names []map[string]string, fileCollections map[string]map[string]any, ...) []map[string]any

+ func CompilePlugin(dir string) (*plugin.Plugin, error)

+ func CopyDirectory(src, dest string) error

+ func CopyFile(srcPath, destPath string) error

+ func CreateCURLBody(content any, contentType string) (string, error)

+ func EncodeContent(content any, contentType string) ([]byte, error)

+ func ExtractZip(zipReader *zip.Reader, targetDir string, onlyPrefixes []string) error

+ func FixSchemaTypeTypos(typ string) string

+ func GenerateContentArray(schema *Schema, valueReplacer ValueReplacer, state *ReplaceState) any

+ func GenerateContentFromFileProperties(filePath, contentType string, valueReplacer ValueReplacer) []byte

+ func GenerateContentFromSchema(schema *Schema, valueReplacer ValueReplacer, state *ReplaceState) any

+ func GenerateContentObject(schema *Schema, valueReplacer ValueReplacer, state *ReplaceState) any

+ func GenerateQuery(valueReplacer ValueReplacer, params Parameters) string

+ func GenerateRequestHeaders(parameters Parameters, valueReplacer ValueReplacer) map[string]any

+ func GenerateResponseHeaders(headers Headers, valueReplacer ValueReplacer) http.Header

+ func GenerateURLFromSchemaParameters(path string, valueResolver ValueReplacer, params Parameters) string

+ func GetFakeFuncFactoryWithString() map[string]FakeFuncFactoryWithString

+ func GetFakes() map[string]FakeFunc

+ func GetFileContentsFromURL(client *http.Client, url string) ([]byte, string, error)

+ func GetFileHash(file io.Reader) string

+ func GetOpenAPITypeFromValue(value any) string

+ func HasCorrectSchemaValue(ctx *ReplaceContext, value any) bool

+ func IsCorrectlyReplacedType(value any, neededType string) bool

+ func IsEmptyDir(path string) bool

+ func IsJsonType(content []byte) bool

+ func IsMatchSchemaReadWriteToState(schema *Schema, state *ReplaceState) bool

+ func IsYamlType(content []byte) bool

+ func ReplaceFromContext(ctx *ReplaceContext) any

+ func ReplaceFromSchemaExample(ctx *ReplaceContext) any

+ func ReplaceFromSchemaFallback(ctx *ReplaceContext) any

+ func ReplaceFromSchemaFormat(ctx *ReplaceContext) any

+ func ReplaceFromSchemaPrimitive(ctx *ReplaceContext) any

+ func ReplaceInHeaders(ctx *ReplaceContext) any

+ func ReplaceInPath(ctx *ReplaceContext) any

+ func ReplaceValueWithContext(path []string, contextData any) interface

+ func SaveFile(filePath string, data []byte) error

+ func TransformHTTPCode(httpCode string) int

+ type Any interface

+ type AppConfig struct

+ ContextAreaPrefix string

+ ContextURL string

+ CreateFileStructure bool

+ DisableSwaggerUI bool

+ DisableUI bool

+ Editor *EditorConfig

+ HomeURL string

+ Paths *Paths

+ Port int

+ ServiceURL string

+ SettingsURL string

+ func NewDefaultAppConfig(baseDir string) *AppConfig

+ func (a *AppConfig) IsValidPrefix(prefix string) bool

+ type AuthLocation string

+ const AuthLocationHeader

+ const AuthLocationQuery

+ type AuthScheme string

+ const AuthSchemeBasic

+ const AuthSchemeBearer

+ type AuthType string

+ const AuthTypeApiKey

+ const AuthTypeHTTP

+ type BoolValue bool

+ func (b BoolValue) Get() any

+ type CacheOperationAdapter struct

+ func (a *CacheOperationAdapter) GetRequest(securityComponents SecurityComponents) *Request

+ func (a *CacheOperationAdapter) GetResponse() *Response

+ func (a *CacheOperationAdapter) ID() string

+ func (a *CacheOperationAdapter) Unwrap() Operation

+ func (a *CacheOperationAdapter) WithParseConfig(parseConfig *ParseConfig) Operation

+ type CacheStorage interface

+ Get func(key string) (any, bool)

+ Set func(key string, value any) error

+ type Config struct

+ App *AppConfig

+ BaseDir string

+ Services map[string]*ServiceConfig

+ func MustConfig(baseDir string) *Config

+ func NewConfigFromContent(content []byte) (*Config, error)

+ func NewDefaultConfig(baseDir string) *Config

+ func (c *Config) EnsureConfigValues()

+ func (c *Config) GetApp() *AppConfig

+ func (c *Config) GetServiceConfig(service string) *ServiceConfig

+ func (c *Config) Reload()

+ type ContentExample struct

+ CURL string

+ type Document interface

+ FindOperation func(options *OperationDescription) Operation

+ GetResources func() map[string][]string

+ GetSecurity func() SecurityComponents

+ GetVersion func() string

+ type EditorConfig struct

+ FontSize int

+ Theme string

+ type FakeFunc func() MixedValue

+ type FakeFuncFactoryWithString func(value string) FakeFunc

+ type FileProperties struct

+ ContentType string

+ Extension string

+ FileName string

+ FilePath string

+ IsOpenAPI bool

+ Method string

+ Prefix string

+ Resource string

+ ServiceName string

+ Spec Document

+ func GetPropertiesFromFilePath(filePath string, appCfg *AppConfig) (*FileProperties, error)

+ func (f *FileProperties) IsEqual(other *FileProperties) bool

+ type Float64Value float64

+ func (f Float64Value) Get() any

+ type GenerateRequestOptions struct

+ Method string

+ Operation Operation

+ Path string

+ PathPrefix string

+ type GeneratedRequest struct

+ Body string

+ ContentSchema *Schema

+ ContentType string

+ Examples *ContentExample

+ Headers map[string]any

+ Method string

+ Path string

+ Query string

+ Request *http.Request

+ func NewRequestFromFixedResource(path, method, contentType string, valueReplacer ValueReplacer) *GeneratedRequest

+ func NewRequestFromOperation(options *GenerateRequestOptions, securityComponents SecurityComponents, ...) *GeneratedRequest

+ type GeneratedResponse struct

+ Content []byte

+ ContentType string

+ Headers http.Header

+ Operation Operation

+ Request *http.Request

+ StatusCode int

+ func NewResponseFromFixedResource(filePath, contentType string, valueReplacer ValueReplacer) *GeneratedResponse

+ func NewResponseFromOperation(req *http.Request, operation Operation, valueReplacer ValueReplacer) *GeneratedResponse

+ type HTTPStatusConfig struct

+ Exact int

+ Range string

+ func (s *HTTPStatusConfig) Is(status int) bool

+ type Headers map[string]*Parameter

+ type HttpStatusFailOnConfig []HTTPStatusConfig

+ func (ss HttpStatusFailOnConfig) Is(status int) bool

+ type IntValue int

+ func (i IntValue) Get() any

+ type KinDocument struct

+ func NewDocumentFromFile(filePath string) (*KinDocument, error)

+ func (d *KinDocument) FindOperation(options *OperationDescription) Operation

+ func (d *KinDocument) GetResources() map[string][]string

+ func (d *KinDocument) GetSecurity() SecurityComponents

+ func (d *KinDocument) GetVersion() string

+ type KinOperation struct

+ func (op *KinOperation) GetRequest(securityComponents SecurityComponents) *Request

+ func (op *KinOperation) GetResponse() *Response

+ func (op *KinOperation) ID() string

+ func (op *KinOperation) Unwrap() Operation

+ func (op *KinOperation) WithParseConfig(config *ParseConfig) Operation

+ type KinValidator struct

+ func NewValidator(_ Document) *KinValidator

+ func (v *KinValidator) ValidateRequest(req *GeneratedRequest) []error

+ func (v *KinValidator) ValidateResponse(res *GeneratedResponse) []error

+ type MemoryStorage struct

+ func NewMemoryStorage() *MemoryStorage

+ func (s *MemoryStorage) Get(key string) (any, bool)

+ func (s *MemoryStorage) Set(key string, value any) error

+ type MixedValue interface

+ Get func() any

+ type Operation interface

+ GetRequest func(securityComponents SecurityComponents) *Request

+ GetResponse func() *Response

+ ID func() string

+ Unwrap func() Operation

+ WithParseConfig func(*ParseConfig) Operation

+ func NewCacheOperationAdapter(service string, operation Operation, storage CacheStorage) Operation

+ type OperationDescription struct

+ Method string

+ Resource string

+ Service string

+ type Parameter struct

+ Example any

+ In string

+ Name string

+ Required bool

+ Schema *Schema

+ type Parameters []*Parameter

+ type ParseConfig struct

+ MaxLevels int

+ MaxRecursionLevels int

+ OnlyRequired bool

+ func NewParseConfig() *ParseConfig

+ type ParsedContextResult struct

+ Aliases map[string]string

+ Result map[string]any

+ func ParseContextFile(filePath string, fakes map[string]FakeFunc) (*ParsedContextResult, error)

+ func ParseContextFromBytes(content []byte, fakes map[string]FakeFunc) (*ParsedContextResult, error)

+ type Paths struct

+ Base string

+ Callbacks string

+ ConfigFile string

+ Contexts string

+ Data string

+ Docs string

+ Resources string

+ Samples string

+ Services string

+ ServicesFixedRoot string

+ ServicesOpenAPI string

+ UI string

+ func NewPaths(baseDir string) *Paths

+ type ReplaceContext struct

+ AreaPrefix string

+ Data []map[string]any

+ Faker faker.Faker

+ Schema any

+ State *ReplaceState

+ type ReplaceState struct

+ ContentType string

+ ElementIndex int

+ IsContentReadOnly bool

+ IsContentWriteOnly bool

+ IsHeader bool

+ IsPathParam bool

+ NamePath []string

+ func NewReplaceState(opts ...ReplaceStateOption) *ReplaceState

+ func NewReplaceStateWithName(name string) *ReplaceState

+ func (s *ReplaceState) NewFrom(src *ReplaceState) *ReplaceState

+ func (s *ReplaceState) WithOptions(options ...ReplaceStateOption) *ReplaceState

+ type ReplaceStateOption func(*ReplaceState)

+ func WithContentType(value string) ReplaceStateOption

+ func WithElementIndex(value int) ReplaceStateOption

+ func WithHeader() ReplaceStateOption

+ func WithName(name string) ReplaceStateOption

+ func WithPath() ReplaceStateOption

+ func WithReadOnly() ReplaceStateOption

+ func WithWriteOnly() ReplaceStateOption

+ type Replacer func(ctx *ReplaceContext) any

+ type Request struct

+ Body *RequestBody

+ Parameters Parameters

+ type RequestBody struct

+ Schema *Schema

+ Type string

+ type Response struct

+ Content *Schema

+ ContentType string

+ Headers Headers

+ StatusCode int

+ type Schema struct

+ Default any

+ Deprecated bool

+ Enum []any

+ Example any

+ Examples []any

+ Format string

+ Items *Schema

+ MaxItems int64

+ MaxLength int64

+ MaxProperties int64

+ Maximum float64

+ MinItems int64

+ MinLength int64

+ MinProperties int64

+ Minimum float64

+ MultipleOf float64

+ Not *Schema

+ Nullable bool

+ Pattern string

+ Properties map[string]*Schema

+ ReadOnly bool

+ Required []string

+ Type string

+ WriteOnly bool

+ func NewSchemaFromKin(schema *openapi3.Schema, parseConfig *ParseConfig) *Schema

+ type SchemaWithContentType struct

+ ContentType string

+ Schema *Schema

+ type SecurityComponent struct

+ In AuthLocation

+ Name string

+ Scheme AuthScheme

+ Type AuthType

+ type SecurityComponents map[string]*SecurityComponent

+ type ServiceCacheConfig struct

+ Schema bool

+ func NewServiceCacheConfig() *ServiceCacheConfig

+ type ServiceConfig struct

+ Cache *ServiceCacheConfig

+ Contexts []map[string]string

+ Errors *ServiceError

+ Latency time.Duration

+ ParseConfig *ParseConfig

+ RequestTransformer string

+ ResponseTransformer string

+ Upstream *UpstreamConfig

+ Validate *ServiceValidateConfig

+ func NewServiceConfig() *ServiceConfig

+ type ServiceError struct

+ Chance int

+ Codes map[int]int

+ func NewServiceErrorConfig() *ServiceError

+ func (s *ServiceError) GetError() int

+ type ServiceValidateConfig struct

+ Request bool

+ Response bool

+ func NewServiceValidateConfig() *ServiceValidateConfig

+ type StringValue string

+ func (s StringValue) Get() any

+ type UploadedFile struct

+ Content []byte

+ Extension string

+ Filename string

+ Size int64

+ func GetRequestFile(r *http.Request, fieldName string) (*UploadedFile, error)

+ type UpstreamConfig struct

+ FailOn *UpstreamFailOnConfig

+ Headers map[string]string

+ URL string

+ type UpstreamFailOnConfig struct

+ HTTPStatus HttpStatusFailOnConfig

+ TimeOut time.Duration

+ type Validator interface

+ ValidateRequest func(req *GeneratedRequest) []error

+ ValidateResponse func(res *GeneratedResponse) []error

+ type ValueReplacer func(schemaOrContent any, state *ReplaceState) any

+ func CreateValueReplacer(cfg *Config, replacers []Replacer, contexts []map[string]any) ValueReplacer

Oct 29, 2024

Changes in this version

+ func Base64Encode(input string) string

Oct 4, 2023

Changes in this version

+ var PlaceholderRegex = regexp.MustCompile(`\{[^\}]*\}`)

+ func AppendSliceFirstNonEmpty(data []T, value ...T) []T

+ func CopyNestedMap(source map[string]map[string]any) map[string]map[string]any

+ func ExtractPlaceholders(input string) []string

+ func GetRandomKeyFromMap(m map[string]T) string

+ func GetRandomSliceValue(slice []T) T

+ func GetSliceMaxRepetitionNumber(values []T) int

+ func GetSortedMapKeys(content map[string]T) []string

+ func GetValueByDottedPath(data map[string]any, path string) any

+ func IsInteger(value any) bool

+ func IsMap(i any) bool

+ func IsNumber(value any) bool

+ func IsSliceUnique(path []T) bool

+ func IsValidHTTPVerb(verb string) bool

+ func IsValidURLResource(urlPattern string) bool

+ func MapToURLEncodedForm(data map[string]any) string

+ func MaybeRegexPattern(input string) bool

+ func RemovePointer(value *T) T

+ func SetValueByDottedPath(data map[string]any, path string, value any)

+ func SliceContains(slice []T, value T) bool

+ func SliceDeleteAtIndex(slice []T, index int) []T

+ func SliceUnique(slice []T) []T

+ func ToFloat64(value any) (float64, error)

+ func ToInt32(value any) (int32, bool)

+ func ToInt64(value any) (int64, bool)

+ func ToSnakeCase(input string) string

+ func ToString(value any) string

+ func ValidateStringWithPattern(input string, pattern string) bool