openapi

Documentation

Index

• Constants
• func MakeClientEnvName(serviceName string) string
• type GenerationMeta
• type OpenAPIGenerator
  • func NewOpenAPIGenerator(ctx *gencontext.GenContext) (OpenAPIGenerator, error)
  • func (g *OpenAPIGenerator) GenerateClient(ctx *gencontext.GenContext, clientName string) error
  • func (g *OpenAPIGenerator) GenerateServer(ctx *gencontext.GenContext) error
  • func (g *OpenAPIGenerator) NeedGenerateClient(ctx *gencontext.GenContext, schemaRelDir string) (bool, error)
  • func (g *OpenAPIGenerator) NeedGenerateServer(ctx *gencontext.GenContext, schemaRelDir string) (bool, error)
  • func (g *OpenAPIGenerator) Prepare(ctx *gencontext.GenContext) error
  • func (g *OpenAPIGenerator) PrepareSync(ctx *gencontext.GenContext) error
  • func (g *OpenAPIGenerator) RemoveClient(ctx *gencontext.GenContext, clientName string) error
• type OpenAPIGeneratorInfo
• type OpenAPIGeneratorMode
• type OpenapiStep
  • func NewOpenapiStep() OpenapiStep
  • func (s OpenapiStep) Execute(ctx *gencontext.GenContext) (core.StepResult, error)
  • func (s OpenapiStep) Name() string

Constants

const (
	CACHE_SERVER_SUBDIR = "server"
	CACHE_CLIENT_SUBDIR = "client"
	SERVER_PACKAGE_NAME = "openapi"

	FILE_TIME_FILENAME     = ".timestamps.yaml"
	GENERATED_API_FILENAME = "api_generated.yaml"
)

const (
	CLIENTS_FILENAME = ".clients.yaml"
)

const (
	GENERATION_META_FILENAME = "generation_metadata.yaml"
)

Functions

func MakeClientEnvName

func MakeClientEnvName(serviceName string) string

Types

type GenerationMeta

type GenerationMeta struct {
	MifyVersion string `yaml:"mify_version"`
}

type OpenAPIGenerator

type OpenAPIGenerator struct {
	// contains filtered or unexported fields
}

func NewOpenAPIGenerator

func NewOpenAPIGenerator(ctx *gencontext.GenContext) (OpenAPIGenerator, error)

func (*OpenAPIGenerator) GenerateClient

func (g *OpenAPIGenerator) GenerateClient(ctx *gencontext.GenContext, clientName string) error

func (*OpenAPIGenerator) GenerateServer

func (g *OpenAPIGenerator) GenerateServer(ctx *gencontext.GenContext) error

func (*OpenAPIGenerator) NeedGenerateClient

func (g *OpenAPIGenerator) NeedGenerateClient(ctx *gencontext.GenContext, schemaRelDir string) (bool, error)

func (*OpenAPIGenerator) NeedGenerateServer

func (g *OpenAPIGenerator) NeedGenerateServer(ctx *gencontext.GenContext, schemaRelDir string) (bool, error)

func (*OpenAPIGenerator) Prepare

func (g *OpenAPIGenerator) Prepare(ctx *gencontext.GenContext) error

func (*OpenAPIGenerator) PrepareSync

func (g *OpenAPIGenerator) PrepareSync(ctx *gencontext.GenContext) error

func (*OpenAPIGenerator) RemoveClient

func (g *OpenAPIGenerator) RemoveClient(ctx *gencontext.GenContext, clientName string) error

type OpenAPIGeneratorInfo

type OpenAPIGeneratorInfo struct {
	GitHost       string
	GitNamespace  string
	GitRepository string
	GoModule      string
	ServiceName   string
}

type OpenAPIGeneratorMode

type OpenAPIGeneratorMode int16

const (
	Server OpenAPIGeneratorMode = iota
	Client
)

type OpenapiStep

type OpenapiStep struct {
}

func NewOpenapiStep

func NewOpenapiStep() OpenapiStep

func (OpenapiStep) Execute

func (s OpenapiStep) Execute(ctx *gencontext.GenContext) (core.StepResult, error)

func (OpenapiStep) Name

func (s OpenapiStep) Name() string