openapi

Documentation

Overview

Package openapi provides the OpenAPI module plugin for the workflow engine. It registers the "openapi" module type which parses OpenAPI v3 specifications, generates HTTP routes, validates requests, and optionally serves Swagger UI.

Index

• type Plugin
  • func New() *Plugin
  • func (p *Plugin) Capabilities() []capability.Contract
  • func (p *Plugin) ModuleFactories() map[string]plugin.ModuleFactory
  • func (p *Plugin) ModuleSchemas() []*schema.ModuleSchema
  • func (p *Plugin) WiringHooks() []plugin.WiringHook

Types

type Plugin

type Plugin struct {
	plugin.BaseEnginePlugin
}

Plugin provides the "openapi" module type and its wiring hook.

func New

func New() *Plugin

New creates a new OpenAPI plugin.

func (*Plugin) Capabilities

func (p *Plugin) Capabilities() []capability.Contract

Capabilities returns the capability contracts this plugin defines.

func (*Plugin) ModuleFactories

func (p *Plugin) ModuleFactories() map[string]plugin.ModuleFactory

ModuleFactories returns the factory for the "openapi" module type.

func (*Plugin) ModuleSchemas

func (p *Plugin) ModuleSchemas() []*schema.ModuleSchema

ModuleSchemas returns the UI schema definition for the "openapi" module type.

func (*Plugin) WiringHooks

func (p *Plugin) WiringHooks() []plugin.WiringHook

WiringHooks returns the post-init wiring function that registers OpenAPI routes on the appropriate HTTP router.