respec

package

v0.2.2 Latest Latest Go to latest Published: Jun 23, 2025 License: MIT Imports: 6 Imported by: 0

Details

Package respec provides a fluent API for adding OpenAPI metadata.

This section is empty.

This section is empty.

This section is empty.

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

func GetByHandler(handler types.Object) *Builder

func Handler(handler http.HandlerFunc) *Builder

Handler wraps an http.HandlerFunc to allow for endpoint-specific metadata.

func (b *Builder) Description(d string) *Builder

func (b *Builder) GetDescription() string

func (b *Builder) GetSecurity() []string

func (b *Builder) GetSummary() string

func (b *Builder) GetTags() []string

func (b *Builder) Security(schemeName string) *Builder

func (b *Builder) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (b *Builder) Summary(s string) *Builder

func (b *Builder) Tag(tags ...string) *Builder

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

func Meta(router interface{}) *GroupBuilder

Meta provides a way to attach metadata to a router instance within a specific scope.

func NewGroupBuilder() *GroupBuilder

NewGroupBuilder is exported for use by the analyzer.

func (b *GroupBuilder) GetSecurity() []string

func (b *GroupBuilder) GetTags() []string

func (b *GroupBuilder) Security(schemeName string) *GroupBuilder

func (b *GroupBuilder) Tag(tags ...string) *GroupBuilder