openapi

package

Go to main page

Versions in this module

v0

v0.3.6

Nov 5, 2025

Changes in this version

+ const ParameterInCookie

+ const ParameterInHeader

+ const ParameterInPath

+ const ParameterInQuery

+ type ParameterIn string

type ReflectorConfig

+ ParameterTagMapping map[ParameterIn]string

v0.3.5

Oct 25, 2025

Changes in this version

type ContentUnit

+ Encoding map[string]string

v0.3.4

Oct 17, 2025

v0.3.3

Aug 12, 2025

Changes in this version

type Config

+ CacheAge *int

+ RapiDocConfig *config.RapiDoc

+ ReDocConfig *config.ReDoc

+ ScalarConfig *config.Scalar

v0.3.2

Aug 10, 2025

Changes in this version

type Config

+ RedocConfig *RedocConfig

+ SpecPath string

+ StoplightElementsConfig *StoplightElementsConfig

+ SwaggerUIConfig *SwaggerUIConfig

+ UIProvider UIProvider

+ type RedocConfig struct

+ DisableSearch bool

+ HideDownload bool

+ HideSchemaTitles bool

+ type StoplightElementsConfig struct

+ HideExport bool

+ HideSchemas bool

+ HideTryIt bool

+ Layout string

+ Logo string

+ Router string

+ type SwaggerUIConfig struct

+ HideCurl bool

+ JsonEditor bool

+ PreAuthorizeApiKey map[string]string

+ SettingsUI map[string]string

+ ShowTopBar bool

+ type UIProvider uint8

+ const UIProviderRedoc

+ const UIProviderStoplightElements

+ const UIProviderSwaggerUI

v0.3.1

Aug 9, 2025

v0.3.0

Aug 7, 2025

v0.2.4

Aug 4, 2025

v0.2.4-dev.1

Aug 4, 2025

v0.2.3

Aug 4, 2025

v0.2.3-dev.2

Aug 4, 2025

v0.2.2

Aug 3, 2025

v0.2.1-dev.1

Aug 3, 2025

v0.2.0

Aug 3, 2025

Changes in this version

type Config

+ TermsOfService *string

+ type ContentUnit struct

+ ContentType string

+ Description string

+ HTTPStatus int

+ IsDefault bool

+ Structure any

+ type OAuthFlowsAuthorizationCode struct

+ AuthorizationURL string

+ MapOfAnything map[string]any

+ RefreshURL *string

+ Scopes map[string]string

+ TokenURL string

+ type OAuthFlowsClientCredentials struct

+ MapOfAnything map[string]any

+ RefreshURL *string

+ Scopes map[string]string

+ TokenURL string

+ type OAuthFlowsImplicit struct

+ AuthorizationURL string

+ MapOfAnything map[string]any

+ RefreshURL *string

+ Scopes map[string]string

+ type OAuthFlowsPassword struct

+ MapOfAnything map[string]any

+ RefreshURL *string

+ Scopes map[string]string

+ TokenURL string

v0.2.0-dev.2

Aug 3, 2025

v0.2.0-dev.1

Aug 3, 2025

v0.1.5

Aug 2, 2025

v0.1.4

Jul 31, 2025

Changes in this version

type Config

+ DisableDocs bool

+ PathParser PathParser

+ type PathParser interface

+ Parse func(path string) (string, error)

v0.1.3

Jul 31, 2025

v0.1.2

Jul 31, 2025

Changes in this version

+ const SecuritySchemeAPIKeyInCookie

+ const SecuritySchemeAPIKeyInHeader

+ const SecuritySchemeAPIKeyInQuery

+ type Config struct

+ BaseURL string

+ Contact *Contact

+ Description *string

+ DisableOpenAPI bool

+ DocsPath string

+ ExternalDocs *ExternalDocs

+ License *License

+ Logger Logger

+ OpenAPIVersion string

+ ReflectorConfig *ReflectorConfig

+ SecuritySchemes map[string]*SecurityScheme

+ Servers []Server

+ SwaggerConfig *SwaggerConfig

+ Tags []Tag

+ Title string

+ Version string

+ type Contact struct

+ Email string

+ MapOfAnything map[string]any

+ Name string

+ URL string

+ type ExternalDocs struct

+ Description string

+ MapOfAnything map[string]any

+ URL string

+ type InterceptDefNameFunc func(t reflect.Type, defaultDefName string) string

+ type InterceptPropFunc func(params InterceptPropParams) error

+ type InterceptPropParams struct

+ Context *jsonschema.ReflectContext

+ Field reflect.StructField

+ Name string

+ ParentSchema *jsonschema.Schema

+ Path []string

+ Processed bool

+ PropertySchema *jsonschema.Schema

+ type InterceptSchemaFunc func(params InterceptSchemaParams) (stop bool, err error)

+ type InterceptSchemaParams struct

+ Context *jsonschema.ReflectContext

+ Processed bool

+ Schema *jsonschema.Schema

+ Value reflect.Value

+ type License struct

+ Identifier string

+ MapOfAnything map[string]any

+ Name string

+ URL string

+ type Logger interface

+ Printf func(format string, v ...any)

+ type OAuthFlows struct

+ AuthorizationCode *OAuthFlowsDefsAuthorizationCode

+ ClientCredentials *OAuthFlowsDefsClientCredentials

+ Implicit *OAuthFlowsDefsImplicit

+ MapOfAnything map[string]any

+ Password *OAuthFlowsDefsPassword

+ type OAuthFlowsDefsAuthorizationCode struct

+ AuthorizationURL string

+ MapOfAnything map[string]any

+ RefreshURL *string

+ Scopes map[string]string

+ TokenURL string

+ type OAuthFlowsDefsClientCredentials struct

+ MapOfAnything map[string]any

+ RefreshURL *string

+ Scopes map[string]string

+ TokenURL string

+ type OAuthFlowsDefsImplicit struct

+ AuthorizationURL string

+ MapOfAnything map[string]any

+ RefreshURL *string

+ Scopes map[string]string

+ type OAuthFlowsDefsPassword struct

+ MapOfAnything map[string]any

+ RefreshURL *string

+ Scopes map[string]string

+ TokenURL string

+ type ReflectorConfig struct

+ InlineRefs bool

+ InterceptDefNameFunc InterceptDefNameFunc

+ InterceptPropFunc InterceptPropFunc

+ InterceptSchemaFunc InterceptSchemaFunc

+ RootNullable bool

+ RootRef bool

+ StripDefNamePrefix []string

+ TypeMappings []TypeMapping

+ type SecurityScheme struct

+ APIKey *SecuritySchemeAPIKey

+ Description *string

+ HTTPBearer *SecuritySchemeHTTPBearer

+ MapOfAnything map[string]any

+ OAuth2 *SecuritySchemeOAuth2

+ type SecuritySchemeAPIKey struct

+ In SecuritySchemeAPIKeyIn

+ Name string

+ type SecuritySchemeAPIKeyIn string

+ type SecuritySchemeHTTPBearer struct

+ BearerFormat *string

+ Scheme string

+ type SecuritySchemeOAuth2 struct

+ Flows OAuthFlows

+ type Server struct

+ Description *string

+ MapOfAnything map[string]any

+ URL string

+ Variables map[string]ServerVariable

+ type ServerVariable struct

+ Default string

+ Description string

+ Enum []string

+ MapOfAnything map[string]any

+ type SwaggerConfig struct

+ HideCurl bool

+ JsonEditor bool

+ PreAuthorizeApiKey map[string]string

+ Proxy bool

+ SettingsUI map[string]string

+ ShowTopBar bool

+ type Tag struct

+ Description string

+ ExternalDocs *ExternalDocs

+ MapOfAnything map[string]any

+ Name string

+ type TypeMapping struct

+ Dst any

+ Src any

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