api

type BufferedWriter ¶

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

BufferedWriter is a writer that captures the response. Used to capture the template execution result.

func NewBufferedResponseWriter() *BufferedWriter

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

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

func (bw *BufferedWriter) WriteHeader(statusCode int)

type GenerateRequest ¶

type GenerateRequest struct {
	Path    string         `json:"path"`
	Method  string         `json:"method"`
	Context map[string]any `json:"context"`
}

GenerateRequest is a struct that represents a request to generate a resource.

type GenerateResponse ¶

type GenerateResponse struct {
}

type Handler ¶

type Handler interface {
	Routes() RouteDescriptions
	RegisterRoutes(router chi.Router)
	Generate(w http.ResponseWriter, r *http.Request)
}

Handler defines a minimal interface for request handlers.

type HandlerOption ¶

type HandlerOption func(*handlerOptions)

HandlerOption configures service registration behavior.

func WithMiddleware(mw []func(*middleware.Params) func(http.Handler) http.Handler) HandlerOption

type HistoryHandler ¶ added in v2.1.76

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

HistoryHandler handles history routes.

type HistoryListResponse ¶ added in v2.1.76

type HistoryListResponse struct {
	Items []*db.HistoryEntry `json:"items"`
}

HistoryListResponse is the response for history list endpoint.

type HistorySummary ¶ added in v2.1.82

type HistorySummary struct {
	ID        string              `json:"id"`
	Resource  string              `json:"resource"`
	Request   *db.HistoryRequest  `json:"request,omitempty"`
	Response  *db.HistoryResponse `json:"response,omitempty"`
	CreatedAt time.Time           `json:"createdAt"`
}

HistorySummary is a slim version of HistoryEntry for list responses (no bodies).

type HistorySummaryListResponse ¶ added in v2.1.82

type HistorySummaryListResponse struct {
	Items []*HistorySummary `json:"items"`
}

HistorySummaryListResponse is the response for history list endpoint.

type JSONResponse ¶

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

JSONResponse is a response builder for JSON responses.

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 ResourceResponse ¶

type ResourceResponse struct {
	Method      string `json:"method"`
	Path        string `json:"path"`
	Extension   string `json:"extension"`
	ContentType string `json:"contentType"`
	Content     string `json:"content"`
}

type RouteDescription ¶

type RouteDescription struct {
	ID          string `json:"id"`
	Method      string `json:"method"`
	Path        string `json:"path"`
	ContentType string `json:"contentType"`
}

RouteDescription describes a route for the UI Application. Path is relative to the service prefix.

type RouteDescriptions ¶

type RouteDescriptions []*RouteDescription

RouteDescriptions is a slice of RouteDescription. Allows to add custom methods.

func (rs RouteDescriptions) Sort()

type RouteType ¶

type RouteType string

const (
	RouteTypeOpenAPI RouteType = "openapi"
	RouteTypeStatic  RouteType = "static"
)

type Router ¶

type Router struct {
	chi.Router
	// contains filtered or unexported fields
}

Router is the central HTTP router for all services

func NewRouter(options ...RouterOption) *Router

func (r *Router) Config() *config.AppConfig

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

func (r *Router) GetDB(serviceName string) db.DB

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

func (r *Router) RegisterHTTPHandler(
	cfg *config.ServiceConfig,
	handlerFactory func(db.DB) Handler,
	opts ...HandlerOption,
)

func (r *Router) RegisterService(
	cfg *config.ServiceConfig,
	handler Handler,
	opts ...HandlerOption,
)

type RouterOption ¶

type RouterOption func(*Router)

func WithConfigOption(cfg *config.AppConfig) RouterOption

type SavedResourceResponse ¶

type SavedResourceResponse struct {
	Success bool   `json:"success"`
	Message string `json:"message"`
	ID      int    `json:"id"`
}

type ServiceConfigHandler ¶ added in v2.1.84

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

ServiceConfigHandler handles service configuration routes.

type ServiceDescription ¶

type ServiceDescription struct {
	Method    string
	Path      string
	Ext       string
	IsOpenAPI bool
}

ServiceDescription is a struct created from the service payload to facilitate file path composition.

type ServiceEmbedded ¶

type ServiceEmbedded struct {
	Name string `json:"name"`
}

type ServiceHandler ¶

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

ServiceHandler handles service routes.

type ServiceItem ¶

type ServiceItem struct {
	Name    string                `json:"name"`
	Handler Handler               `json:"-"`
	Config  *config.ServiceConfig `json:"-"`
}

ServiceItem represents a service with its handler. Service can hold multiple OpenAPI specs.

type ServiceItemResponse ¶

type ServiceItemResponse struct {
	Name           string `json:"name"`
	ResourceNumber int    `json:"resourceNumber"`
}

type ServiceListResponse ¶

type ServiceListResponse struct {
	Items []*ServiceItemResponse `json:"items"`
}

type ServiceParams ¶

type ServiceParams struct {
	// AppConfig is the application-wide configuration.
	// Contains BaseURL, InternalURL, and Extra map for custom values.
	AppConfig *config.AppConfig

	// ServiceConfig is the service-specific configuration.
	ServiceConfig *config.ServiceConfig

	// DB is the database connection for this service.
	DB db.DB
}

ServiceParams provides access to application and service configuration along with the database connection. This struct is passed to user services to allow access to configuration without coupling to framework internals.

Example usage in service.go:

func newService(params *api.ServiceParams) *service {
    baseURL := params.AppConfig.BaseURL
    extra := params.AppConfig.Extra["myKey"]
    return &service{params: params}
}

For custom configuration, you can:

1. Use Extra map in app.yml for simple key-value config
2. Embed and load your own config files in newService

Example app.yml with Extra:

baseURL: https://api.example.com
extra:
  myApiKey: "secret"
  maxRetries: 3

type ServicePayload ¶

type ServicePayload struct {
	IsOpenAPI   bool   `json:"isOpenApi"`
	Method      string `json:"method"`
	Path        string `json:"path"`
	Response    []byte `json:"response"`
	ContentType string `json:"contentType"`
	URL         string `json:"url"`
}

ServicePayload is a struct that represents a new service payload.

type ServiceResourcesResponse ¶

type ServiceResourcesResponse struct {
	Endpoints RouteDescriptions `json:"endpoints"`
}

type SimpleResponse ¶

type SimpleResponse struct {
	Success bool   `json:"success"`
	Message string `json:"message"`
}

SimpleResponse is a simple response type to indicate the success of an operation.

type StaticResponse ¶

type StaticResponse struct {
	ContentType string
	Content     string
}

StaticResponse represents a static response for static handlers.