openapi

package module

v0.1.5 Latest Latest Go to latest Published: Oct 15, 2026 License: MIT Imports: 6 Imported by: 0

Details

Package openapi builds the OpenAPI 3.1 document of an Engine with swaggest/openapi-go.

This section is empty.

This section is empty.

This section is empty.

type Option func(*openapi3.Reflector)

func WithBearer(description string) Option

func WithCookieSession(cookieName string, description string) Option

func WithDescription(description string) Option

func WithTitle(title string) Option

func WithURL(url string) Option

func WithVersion(version string) Option

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

func New(options ...Option) *Spec

func (s *Spec) AddOperation(method, pattern string, operation routespec.Operation) error

func (s *Spec) MarshalJSON() ([]byte, error)