openapi

package

v1.1.0 Latest Latest Go to latest Published: Mar 20, 2026 License: MPL-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/MeGaNeKoS/neoma

Links

Open Source Insights

Documentation ¶

Index ¶

func DefineErrors(op *core.Operation, registry core.Registry, factory core.ErrorHandler, ...)
func Downgrade(oapi *core.OpenAPI) ([]byte, error)
func DowngradeYAML(oapi *core.OpenAPI) ([]byte, error)
func FilterByTag(oapi *core.OpenAPI, tag string) *core.OpenAPI
func FilterExcludeTag(oapi *core.OpenAPI, tag string) *core.OpenAPI
func GenerateInternalSpec(oapi *core.OpenAPI, hiddenOps []*core.Operation) (*core.OpenAPI, error)
func GenerateInternalSpecJSON(oapi *core.OpenAPI, hiddenOps []*core.Operation) ([]byte, error)
func RegisterDocsRoute(adapter core.Adapter, oapi *core.OpenAPI, config core.Config)
func RegisterErrorDocRoutes(adapter core.Adapter, factory core.ErrorHandler, config core.Config)
func RegisterInternalSpecRoutes(adapter core.Adapter, api core.API, config core.Config)
func RegisterSpecRoutes(adapter core.Adapter, oapi *core.OpenAPI, config core.Config)
func YAML(oapi *core.OpenAPI) ([]byte, error)
type ScalarProvider
- func (p ScalarProvider) Render(specURL string, title string) string
type SchemaLinkTransformer
- func NewSchemaLinkTransformer(schemasPath string) *SchemaLinkTransformer
- func (t *SchemaLinkTransformer) OnAddOperation(oapi *core.OpenAPI, op *core.Operation)
- func (t *SchemaLinkTransformer) Transform(ctx core.Context, status string, v any) (any, error)
type StoplightProvider
- func (p StoplightProvider) Render(specURL string, title string) string
type SwaggerUIProvider
- func (p SwaggerUIProvider) Render(specURL string, title string) string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DefineErrors ¶

func DefineErrors(op *core.Operation, registry core.Registry, factory core.ErrorHandler, discovered ...[]core.DiscoveredError)

func Downgrade ¶

func Downgrade(oapi *core.OpenAPI) ([]byte, error)

func DowngradeYAML ¶

func DowngradeYAML(oapi *core.OpenAPI) ([]byte, error)

func FilterByTag ¶

func FilterByTag(oapi *core.OpenAPI, tag string) *core.OpenAPI

func FilterExcludeTag ¶

func FilterExcludeTag(oapi *core.OpenAPI, tag string) *core.OpenAPI

func GenerateInternalSpec ¶

func GenerateInternalSpec(oapi *core.OpenAPI, hiddenOps []*core.Operation) (*core.OpenAPI, error)

func GenerateInternalSpecJSON ¶

func GenerateInternalSpecJSON(oapi *core.OpenAPI, hiddenOps []*core.Operation) ([]byte, error)

func RegisterDocsRoute ¶

func RegisterDocsRoute(adapter core.Adapter, oapi *core.OpenAPI, config core.Config)

func RegisterErrorDocRoutes ¶

func RegisterErrorDocRoutes(adapter core.Adapter, factory core.ErrorHandler, config core.Config)

func RegisterInternalSpecRoutes ¶

func RegisterInternalSpecRoutes(adapter core.Adapter, api core.API, config core.Config)

func RegisterSpecRoutes ¶

func RegisterSpecRoutes(adapter core.Adapter, oapi *core.OpenAPI, config core.Config)

func YAML ¶

func YAML(oapi *core.OpenAPI) ([]byte, error)

Types ¶

type ScalarProvider ¶

type ScalarProvider struct {
	LocalJSPath string
}

func (ScalarProvider) Render ¶

func (p ScalarProvider) Render(specURL string, title string) string

type SchemaLinkTransformer ¶ added in v1.1.0

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

SchemaLinkTransformer adds a Link header with rel="describedBy" and a $schema field to JSON response bodies, pointing to the JSON Schema that describes the response structure (RFC 8288).

func NewSchemaLinkTransformer ¶ added in v1.1.0

func NewSchemaLinkTransformer(schemasPath string) *SchemaLinkTransformer

NewSchemaLinkTransformer creates a transformer that adds a Link header with rel="describedBy" and a $schema field to response bodies.

func (*SchemaLinkTransformer) OnAddOperation ¶ added in v1.1.0

func (t *SchemaLinkTransformer) OnAddOperation(oapi *core.OpenAPI, op *core.Operation)

OnAddOperation is triggered whenever a new operation is added to the API, enabling this transformer to precompute and cache information about the response and schema.

func (*SchemaLinkTransformer) Transform ¶ added in v1.1.0

func (t *SchemaLinkTransformer) Transform(ctx core.Context, status string, v any) (any, error)

Transform adds the Link header and $schema field to the response.

type StoplightProvider ¶

type StoplightProvider struct{}

func (StoplightProvider) Render ¶

func (p StoplightProvider) Render(specURL string, title string) string

type SwaggerUIProvider ¶

type SwaggerUIProvider struct {
	OAuthClientID string
	OAuthScopes   []string
}

func (SwaggerUIProvider) Render ¶

func (p SwaggerUIProvider) Render(specURL string, title string) string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL