astra

Dec 17, 2023

Changes in this version

+ var PredefinedTypeMap = map[string]TypeFormat

type Option

+ func WithCustomTypeMapping(customTypeMap map[string]TypeFormat) Option

+ func WithCustomTypeMappingSingle(key string, valueType string, valueFormat string) Option

type Service

+ CustomTypeMapping map[string]TypeFormat

+ func (s *Service) GetTypeMapping(key string, pkg string) (TypeFormat, bool)

+ type TypeFormat struct

+ Format string

+ Type string

Dec 15, 2023

Changes in this version

+ func BindingTagToContentTypes(bindingTag astTraversal.BindingTagType) []string

+ type BodyParam struct

+ ContentType string

+ Field Field

+ IsArray bool

+ IsBound bool

+ IsMap bool

+ IsRequired bool

+ Name string

type ReturnType

+ ContentType string

Oct 29, 2023

Changes in this version

+ func ContentTypeToBindingTag(contentType string) astTraversal.BindingTagType

+ func ExtractBindingTags(fields map[string]Field) (bindingTags []astTraversal.BindingTagType, uniqueBindings bool)

type Field

+ StructFieldBindingTags astTraversal.BindingTagMap

+ StructFieldValidationTags astTraversal.ValidationTagMap

Oct 22, 2023

Changes in this version

type Route

+ OperationID string

Oct 16, 2023

Changes in this version

type Route

+ RequestHeaders []Param

+ ResponseHeaders []Param

Oct 9, 2023

Changes in this version

type Field

+ EnumValues []any

Oct 3, 2023

Changes in this version

type Service

+ func (s *Service) HandlePassthroughTypes(component *Field)

+ func (s *Service) HandleSubstituteTypes(component *Field)

Oct 2, 2023

Changes in this version

+ type ContextFuncBuilder struct

+ Route *Route

+ Traverser *astTraversal.CallExpressionTraverser

+ func NewContextFuncBuilder(route *Route, traverser *astTraversal.CallExpressionTraverser) *ContextFuncBuilder

+ func (c *ContextFuncBuilder) Build(mapper func(*Route, []any) (*Route, error)) (*Route, error)

+ func (c *ContextFuncBuilder) ExpressionResult() *ContextFuncBuilder

+ func (c *ContextFuncBuilder) Ignored() *ContextFuncBuilder

+ func (c *ContextFuncBuilder) StatusCode() *ContextFuncBuilder

+ func (c *ContextFuncBuilder) Value() *ContextFuncBuilder

+ type CustomFunc func(contextVarName string, contextFuncBuilder *ContextFuncBuilder) (*Route, error)

type Field

+ func AddComponent(prev []Field, n ...Field) []Field

+ func ParseResultToField(result astTraversal.Result) Field

type Option

+ func WithCustomFunc(customFunc CustomFunc) Option

type ReturnType

+ func AddReturnType(prev []ReturnType, n ...ReturnType) []ReturnType

type Service

+ CustomFuncs []CustomFunc

Sep 23, 2023

Changes in this version

+ var AcceptedTypes = []string

+ var ErrConfigNotFound = errors.New("config not found")

+ var ErrConfigPortRequired = errors.New("config port is required")

+ var ErrInputModeNotFound = errors.New("input mode not found")

+ var ErrOutputDirectoryPathRequired = errors.New("output directory path is required")

+ var ErrOutputFilePathRequired = errors.New("output file path is required")

+ var ErrOutputModeNotFound = errors.New("output mode not found")

+ func IsAcceptedType(t string) bool

+ type CLIMode string

+ const CLIModeBuilder

+ const CLIModeNone

+ const CLIModeSetup

+ type Config struct

+ BasePath string

+ Contact Contact

+ Description string

+ Host string

+ License License

+ Port int

+ Secure bool

+ Title string

+ Version string

+ func (c *Config) Validate() error

+ type ConfigBuilder struct

+ func NewConfigBuilder() *ConfigBuilder

+ func (c *ConfigBuilder) Build() (*Config, error)

+ func (c *ConfigBuilder) SetBasePath(basePath string) *ConfigBuilder

+ func (c *ConfigBuilder) SetContact(contact Contact) *ConfigBuilder

+ func (c *ConfigBuilder) SetDescription(description string) *ConfigBuilder

+ func (c *ConfigBuilder) SetHost(host string) *ConfigBuilder

+ func (c *ConfigBuilder) SetLicense(license License) *ConfigBuilder

+ func (c *ConfigBuilder) SetPort(port int) *ConfigBuilder

+ func (c *ConfigBuilder) SetSecure(secure bool) *ConfigBuilder

+ func (c *ConfigBuilder) SetTitle(title string) *ConfigBuilder

+ func (c *ConfigBuilder) SetVersion(version string) *ConfigBuilder

+ type Contact struct

+ Email string

+ Name string

+ URL string

+ type Field struct

+ ArrayLength int64

+ ArrayType string

+ Doc string

+ IsEmbedded bool

+ IsRequired bool

+ MapKeyPackage string

+ MapKeyType string

+ MapValueType string

+ Name string

+ Package string

+ SliceType string

+ StructFields map[string]Field

+ Type string

+ type IOConfiguration map[IOConfigurationKey]any

+ type IOConfigurationKey string

+ const IOConfigurationKeyDirectoryPath

+ const IOConfigurationKeyFilePath

+ type Input struct

+ CreateRoutes ServiceFunction

+ Mode InputMode

+ ParseRoutes ServiceFunction

+ type InputMode string

+ type License struct

+ Name string

+ URL string

+ type Option func(*Service)

+ func WithConfig(config *Config) Option

+ func WithCustomLogLevel(level string) Option

+ func WithCustomLogger(logger zerolog.Logger) Option

+ func WithCustomWorkDir(wd string) Option

+ func WithPathDenyList(denyList string) Option

+ func WithPathDenyListFunc(denyList func(string) bool) Option

+ func WithPathDenyListRegex(regex *regexp.Regexp) Option

+ type Output struct

+ Configuration IOConfiguration

+ Generate ServiceFunction

+ Mode OutputMode

+ type OutputMode string

+ type Param struct

+ Field Field

+ IsArray bool

+ IsBound bool

+ IsMap bool

+ IsRequired bool

+ Name string

+ type Processable struct

+ Name string

+ Pkg string

+ type ReturnType struct

+ Field Field

+ StatusCode int

+ type Route struct

+ Body []Param

+ BodyType string

+ ContentType string

+ Doc string

+ File string

+ Handler string

+ LineNo int

+ Method string

+ Path string

+ PathParams []Param

+ QueryParams []Param

+ ReturnTypes []ReturnType

+ type Service struct

+ CLIMode CLIMode

+ CacheEnabled bool

+ CachePath string

+ Components []Field

+ Config *Config

+ Inputs []Input

+ Log zerolog.Logger

+ Outputs []Output

+ PathDenyList []func(string) bool

+ Routes []Route

+ ToBeProcessed []Processable

+ WorkDir string

+ func New(opts ...Option) *Service

+ func (s *Service) AddRoute(route Route)

+ func (s *Service) Cache() error

+ func (s *Service) Clean() error

+ func (s *Service) ClearCache() error

+ func (s *Service) CompleteParse() error

+ func (s *Service) CreateRoutes() error

+ func (s *Service) Generate() error

+ func (s *Service) GetMainPackageName() (string, error)

+ func (s *Service) HandleSpecialType(component *Field)

+ func (s *Service) LoadCache() error

+ func (s *Service) LoadCacheFromCustomPath(cachePath string) error

+ func (s *Service) MoveTempOutputDir(dirPath, outputDir string) error

+ func (s *Service) Parse() error

+ func (s *Service) ParseRoutes() error

+ func (s *Service) ReplaceRoute(route Route)

+ func (s *Service) SetConfig(config *Config) *Service

+ func (s *Service) Setup() error

+ func (s *Service) SetupParse() error

+ func (s *Service) SetupTempOutputDir(dirPath string) (string, error)

+ func (s *Service) Teardown() error

+ type ServiceFunction func(service *Service) error