connexions

Oct 29, 2024

Changes in this version

type CacheOperationAdapter

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

Oct 4, 2023

Changes in this version

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

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

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

Oct 2, 2023

Changes in this version

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

+ func ToString(value any) string

+ type OpenAPIValidator interface

+ ValidateRequest func(req *Request) []error

+ ValidateResponse func(res *Response) []error

+ func NewKinOpenAPIValidator(_ Document) OpenAPIValidator

+ func NewLibOpenAPIValidator(doc Document) OpenAPIValidator

+ func NewOpenAPIValidator(doc Document) OpenAPIValidator

Sep 27, 2023

Changes in this version

+ func GetOpenAPITypeFromValue(value any) string

type ParseConfig

+ func NewParseConfig() *ParseConfig

type ServiceCacheConfig

+ func NewServiceCacheConfig() *ServiceCacheConfig

type ServiceConfig

+ func NewServiceConfig() *ServiceConfig

type ServiceError

+ func NewServiceErrorConfig() *ServiceError

type ServiceValidateConfig

+ func NewServiceValidateConfig() *ServiceValidateConfig

Sep 26, 2023

Changes in this version

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

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

type ServicePayload

+ URL string

Sep 25, 2023

Changes in this version

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

type ReplaceState

+ IsContentReadOnly bool

+ IsContentWriteOnly bool

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

+ func NewReplaceStateWithName(name string) *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

Sep 25, 2023

Changes in this version

type Schema

+ AdditionalProperties *Schema

Sep 24, 2023

Changes in this version

type Router

+ func (r *Router) RemoveService(name string)

Sep 24, 2023

Changes in this version

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

type BaseHandler

+ func NewBaseHandler() *BaseHandler

+ func (h *BaseHandler) Error(code int, message string, w http.ResponseWriter)

+ func (h *BaseHandler) Success(message string, w http.ResponseWriter)

+ type BufferedWriter struct

+ func NewBufferedResponseWriter() *BufferedWriter

+ func (bw *BufferedWriter) Header() http.Header

+ func (bw *BufferedWriter) Write(p []byte) (int, error)

+ func (bw *BufferedWriter) WriteHeader(statusCode int)

type Router

+ func (r *Router) AddService(item *ServiceItem)

+ func (r *Router) GetContexts() map[string]map[string]any

+ func (r *Router) GetDefaultContexts() []map[string]string

+ func (r *Router) GetServices() map[string]*ServiceItem

+ func (r *Router) SetContexts(contexts map[string]map[string]any, defaultContexts []map[string]string) *Router

+ func (r *Router) SetServices(services map[string]*ServiceItem) *Router

Sep 23, 2023

Changes in this version

+ const FixedRouteType

+ const NULL

+ const OpenAPIRouteType

+ const ParameterInBody

+ const ParameterInHeader

+ const ParameterInPath

+ const ParameterInQuery

+ const RootOpenAPIName

+ const RootServiceName

+ const TypeArray

+ const TypeBoolean

+ const TypeInteger

+ const TypeNumber

+ const TypeObject

+ const TypeString

+ var ErrCreatingDirectories = errors.New("error creating directories")

+ var ErrCreatingFile = errors.New("error creating file")

+ var ErrExtractingFiles = errors.New("error extracting files")

+ var ErrFileUpload = errors.New("error uploading file")

+ var ErrInternalServer = errors.New("internal server error")

+ var ErrInvalidConfig = errors.New("invalid config")

+ var ErrInvalidHTTPVerb = errors.New("invalid HTTP verb")

+ var ErrInvalidURLResource = errors.New("invalid URL resource")

+ var ErrNoPathsInSchema = errors.New("no paths found in schema")

+ var ErrOnlyFixedResourcesAllowedEditing = errors.New("only fixed resources are allowed editing")

+ var ErrOpenAPISpecIsEmpty = errors.New("OpenAPI spec is empty")

+ var ErrReadingZipFile = errors.New("error reading zip file")

+ var ErrReservedPrefix = errors.New("reserved prefix")

+ var ErrResourceMethodNotFound = errors.New("resource method not found")

+ var ErrResourceNotFound = errors.New("resource not found")

+ var ErrSavingFile = errors.New("error saving file")

+ var ErrServiceNotFound = errors.New("service not found")

+ 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 PlaceholderRegex = regexp.MustCompile(`\{[^\}]*\}`)

+ var Replacers = []Replacer

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

+ 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 ComposeFileSavePath(descr *ServiceDescription, paths *Paths) string

+ func ComposeOpenAPISavePath(descr *ServiceDescription, baseDir string) string

+ func ConditionalLoggingMiddleware(cfg *Config) func(http.Handler) http.Handler

+ func CopyDirectory(src, dest string) error

+ func CopyFile(srcPath, destPath string) error

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

+ func ExtractPlaceholders(input string) []string

+ 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 GenerateContentFromSchema(schema *Schema, valueResolver ValueReplacer, state *ReplaceState) any

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

+ func GenerateQuery(valueReplacer ValueReplacer, params OpenAPIParameters) string

+ func GenerateRequestHeaders(parameters OpenAPIParameters, valueReplacer ValueReplacer) any

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

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

+ func GetFakeFuncFactoryWithString() map[string]FakeFuncFactoryWithString

+ func GetFakes() map[string]FakeFunc

+ func GetFileHash(file io.Reader) string

+ func GetJSONPayload(req *http.Request) (*T, error)

+ 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 HandleErrorAndLatency(svcConfig *ServiceConfig, w http.ResponseWriter) bool

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

+ func IsCorrectlyReplacedType(value any, neededType string) bool

+ func IsEmptyDir(path string) bool

+ func IsInteger(value interface{}) bool

+ func IsJsonType(content []byte) bool

+ func IsMap(i any) bool

+ func IsNumber(value interface{}) bool

+ func IsSliceUnique(path []T) bool

+ func IsValidHTTPVerb(verb string) bool

+ func IsValidURLResource(urlPattern string) bool

+ func IsYamlType(content []byte) bool

+ func MaybeRegexPattern(input string) bool

+ func MustFileStructure(paths *Paths) error

+ func NewDocumentFromFileFactory(provider SchemaProvider) func(filePath string) (Document, error)

+ func RemovePointer(value *T) T

+ 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 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 interface{}) (float64, error)

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

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

+ func ToSnakeCase(input string) string

+ func TransformHTTPCode(httpCode string) int

+ func ValidateRequest(req *http.Request, body *Schema, contentType string) error

+ func ValidateResponse(req *http.Request, res *Response, operation Operationer) error

+ func ValidateStringWithPattern(input string, pattern string) bool

+ type APIResponse struct

+ func NewAPIResponse(w http.ResponseWriter) *APIResponse

+ func (r *APIResponse) Send(data []byte)

+ func (r *APIResponse) WithHeader(key string, value string) *APIResponse

+ func (r *APIResponse) WithStatusCode(code int) *APIResponse

+ type Any interface

+ type App struct

+ BluePrints []RouteRegister

+ Paths *Paths

+ Router *Router

+ func NewApp(config *Config) *App

+ func (a *App) AddBluePrint(bluePrint RouteRegister) error

+ func (a *App) Run()

+ type AppConfig struct

+ ContextAreaPrefix string

+ ContextURL string

+ CreateFileStructure bool

+ DisableSwaggerUI bool

+ DisableUI bool

+ Editor *EditorConfig

+ HomeURL string

+ Paths *Paths

+ Port int

+ SchemaProvider SchemaProvider

+ ServiceURL string

+ SettingsURL string

+ func NewDefaultAppConfig(baseDir string) *AppConfig

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

+ type BaseHandler struct

+ func (h *BaseHandler) JSONResponse(w http.ResponseWriter) *JSONResponse

+ func (h *BaseHandler) Response(w http.ResponseWriter) *APIResponse

+ type BaseOperation struct

+ type BaseResponse struct

+ type BoolValue bool

+ func (b BoolValue) Get() any

+ type CacheOperationAdapter struct

+ func (a *CacheOperationAdapter) GetParameters() OpenAPIParameters

+ func (a *CacheOperationAdapter) GetRequestBody() (*Schema, string)

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

+ func (a *CacheOperationAdapter) ID() string

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

+ type CacheStorage interface

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

+ Set func(key string, value any) error

+ type Config struct

+ App *AppConfig

+ Replacers []Replacer

+ 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 ContextHandler struct

+ type ContextListResponse struct

+ Items []string

+ type Document interface

+ FindOperation func(options *OperationDescription) Operationer

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

+ GetVersion func() string

+ Provider func() SchemaProvider

+ func NewKinDocumentFromFile(filePath string) (Document, error)

+ func NewLibOpenAPIDocumentFromFile(filePath string) (Document, error)

+ type EditorConfig struct

+ FontSize int

+ Theme string

+ type ErrorMessage struct

+ Message string

+ func NewErrorMessage(err error) *ErrorMessage

+ type ErrorResponse struct

+ Details []*ErrorMessage

+ Error string

+ type FakeFunc func() MixedValue

+ type FakeFuncFactoryWithString func(value string) FakeFunc

+ type FakeValue interface

+ 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 GenerateResponse struct

+ Request *Request

+ Response *Response

+ type HomeHandler struct

+ type IntValue int

+ func (i IntValue) Get() any

+ type JSONResponse struct

+ func NewJSONResponse(w http.ResponseWriter) *JSONResponse

+ func (r *JSONResponse) Send(data any)

+ func (r *JSONResponse) WithHeader(key string, value string) *JSONResponse

+ func (r *JSONResponse) WithStatusCode(code int) *JSONResponse

+ type KinDocument struct

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

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

+ func (d *KinDocument) GetVersion() string

+ func (d *KinDocument) Provider() SchemaProvider

+ type KinOperation struct

+ func (op *KinOperation) GetParameters() OpenAPIParameters

+ func (op *KinOperation) GetRequestBody() (*Schema, string)

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

+ func (op *KinOperation) ID() string

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

+ type LibV2Document struct

+ ParseConfig *ParseConfig

+ func (d *LibV2Document) FindOperation(options *OperationDescription) Operationer

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

+ func (d *LibV2Document) GetVersion() string

+ func (d *LibV2Document) Provider() SchemaProvider

+ type LibV2Operation struct

+ ParseConfig *ParseConfig

+ func (op *LibV2Operation) GetParameters() OpenAPIParameters

+ func (op *LibV2Operation) GetRequestBody() (*Schema, string)

+ func (op *LibV2Operation) GetResponse() *OpenAPIResponse

+ func (op *LibV2Operation) ID() string

+ func (op *LibV2Operation) WithParseConfig(parseConfig *ParseConfig) Operationer

+ type LibV3Document struct

+ func (d *LibV3Document) FindOperation(options *OperationDescription) Operationer

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

+ func (d *LibV3Document) GetVersion() string

+ func (d *LibV3Document) Provider() SchemaProvider

+ type LibV3Operation struct

+ func (op *LibV3Operation) GetParameters() OpenAPIParameters

+ func (op *LibV3Operation) GetRequestBody() (*Schema, string)

+ func (op *LibV3Operation) GetResponse() *OpenAPIResponse

+ func (op *LibV3Operation) ID() string

+ func (op *LibV3Operation) WithParseConfig(parseConfig *ParseConfig) Operationer

+ 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 OpenAPIHandler struct

+ type OpenAPIHeaders map[string]*OpenAPIParameter

+ type OpenAPIParameter struct

+ Example interface{}

+ In string

+ Name string

+ Required bool

+ Schema *Schema

+ type OpenAPIParameters []*OpenAPIParameter

+ type OpenAPIResponse struct

+ Content *Schema

+ ContentType string

+ Headers OpenAPIHeaders

+ StatusCode int

+ type OperationDescription struct

+ Method string

+ Resource string

+ Service string

+ type Operationer interface

+ GetParameters func() OpenAPIParameters

+ GetRequestBody func() (*Schema, string)

+ GetResponse func() *OpenAPIResponse

+ ID func() string

+ WithParseConfig func(*ParseConfig) Operationer

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

+ type ParseConfig struct

+ MaxLevels int

+ MaxRecursionLevels int

+ OnlyRequired bool

+ type ParsedContextResult struct

+ Aliases map[string]string

+ Result map[string]any

+ func ParseContextFile(filePath string) (*ParsedContextResult, error)

+ func ParseContextFromBytes(content []byte) (*ParsedContextResult, error)

+ type Paths struct

+ Base 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

+ IsHeader bool

+ IsPathParam bool

+ NamePath []string

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

+ func (s *ReplaceState) WithContentType(value string) *ReplaceState

+ func (s *ReplaceState) WithElementIndex(value int) *ReplaceState

+ func (s *ReplaceState) WithHeader() *ReplaceState

+ func (s *ReplaceState) WithName(name string) *ReplaceState

+ func (s *ReplaceState) WithPathParam() *ReplaceState

+ type Replacer func(ctx *ReplaceContext) any

+ type Request struct

+ Body string

+ ContentType string

+ Examples *ContentExample

+ Headers any

+ Method string

+ Path string

+ Query any

+ func NewRequestFromOperation(pathPrefix, path, method string, operation Operationer, ...) *Request

+ type ResourceGeneratePayload struct

+ Replacements map[string]any

+ type ResourceResponse struct

+ Content string

+ ContentType string

+ Extension string

+ Method string

+ Path string

+ type Response struct

+ Content []byte

+ ContentType string

+ Headers http.Header

+ StatusCode int

+ func NewResponseFromOperation(operation Operationer, valueReplacer ValueReplacer) *Response

+ type RouteDescription struct

+ ContentType string

+ File *FileProperties

+ Method string

+ Overwrites bool

+ Path string

+ Type string

+ type RouteDescriptions []*RouteDescription

+ func (rs RouteDescriptions) Sort()

+ type RouteRegister func(router *Router) error

+ type Router struct

+ Config *Config

+ ContextNames []map[string]string

+ Contexts map[string]map[string]any

+ Services map[string]*ServiceItem

+ func NewRouter(config *Config) *Router

+ func (r *Router) RemoveContext(name string)

+ type SavedResourceResponse struct

+ ID int

+ Message string

+ Success bool

+ 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

+ func NewSchemaFromLibOpenAPI(schema *base.Schema, parseConfig *ParseConfig) *Schema

+ type SchemaProvider string

+ const DefaultSchemaProvider

+ const KinOpenAPIProvider

+ const LibOpenAPIProvider

+ type SchemaWithContentType struct

+ ContentType string

+ Schema *Schema

+ type ServiceCacheConfig struct

+ Schema bool

+ type ServiceConfig struct

+ Cache *ServiceCacheConfig

+ Contexts []map[string]string

+ Errors *ServiceError

+ Latency time.Duration

+ ParseConfig *ParseConfig

+ Validate *ServiceValidateConfig

+ type ServiceDescription struct

+ Ext string

+ IsOpenAPI bool

+ Method string

+ Name string

+ Path string

+ type ServiceEmbedded struct

+ Name string

+ type ServiceError struct

+ Chance int

+ Codes map[int]int

+ func (s *ServiceError) GetError() int

+ type ServiceHandler struct

+ type ServiceItem struct

+ Name string

+ OpenAPIFiles []*FileProperties

+ Routes RouteDescriptions

+ func (i *ServiceItem) AddOpenAPIFile(file *FileProperties)

+ func (i *ServiceItem) AddRoutes(routes RouteDescriptions)

+ type ServiceItemResponse struct

+ Name string

+ OpenAPIResources []string

+ type ServiceListResponse struct

+ Items []*ServiceItemResponse

+ type ServicePayload struct

+ ContentType string

+ File *UploadedFile

+ IsOpenAPI bool

+ Method string

+ Name string

+ Path string

+ Response []byte

+ type ServiceResourcesResponse struct

+ Endpoints RouteDescriptions

+ OpenAPISpecNames []string

+ Service *ServiceEmbedded

+ type ServiceValidateConfig struct

+ Request bool

+ Response bool

+ type SettingsHandler struct

+ type SimpleResponse struct

+ Message string

+ Success bool

+ 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 ValueReplacer func(schemaOrContent any, state *ReplaceState) any

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