swaggerutil

Documentation

Index

• Variables
• func DeepLinking(deepLinking bool) func(*Config)
• func DocExpansion(docExpansion string) func(*Config)
• func DomID(domID string) func(*Config)
• func EchoWrapHandler(options ...func(*Config)) echo.HandlerFunc
• func InstanceName(instanceName string) func(*Config)
• func OAuth(config *OAuthConfig) func(*Config)
• func PersistAuthorization(persistAuthorization bool) func(*Config)
• func SyntaxHighlight(syntaxHighlight bool) func(*Config)
• func URL(url string) func(*Config)
• type Config
• type OAuthConfig
• type SwaggErrDetailsResp
• type SwaggErrResp
• type SwaggOKResp

Variables

var WrapHandler = EchoWrapHandler()

WrapHandler wraps swaggerFiles.Handler and returns echo.HandlerFunc

Functions

func DeepLinking

func DeepLinking(deepLinking bool) func(*Config)

DeepLinking true, false.

func DocExpansion

func DocExpansion(docExpansion string) func(*Config)

DocExpansion list, full, none.

func DomID

func DomID(domID string) func(*Config)

DomID #swagger-ui.

func EchoWrapHandler

func EchoWrapHandler(options ...func(*Config)) echo.HandlerFunc

EchoWrapHandler wraps `http.Handler` into `echo.HandlerFunc`.

func InstanceName

func InstanceName(instanceName string) func(*Config)

InstanceName specified swag instance name.

func OAuth

func OAuth(config *OAuthConfig) func(*Config)

func PersistAuthorization

func PersistAuthorization(persistAuthorization bool) func(*Config)

PersistAuthorization Persist authorization information over browser close/refresh. Defaults to false.

func SyntaxHighlight

func SyntaxHighlight(syntaxHighlight bool) func(*Config)

SyntaxHighlight true, false.

func URL

func URL(url string) func(*Config)

URL presents the url pointing to API definition (normally swagger.json or swagger.yaml).

Types

type Config

type Config struct {
	// The url pointing to API definition (normally swagger.json or swagger.yaml). Default is `mockedSwag.json`.
	URLs                 []string
	DocExpansion         string
	DomID                string
	InstanceName         string
	DeepLinking          bool
	PersistAuthorization bool
	SyntaxHighlight      bool

	// The information for OAuth2 integration, if any.
	OAuth *OAuthConfig
}

Config stores echoSwagger configuration variables.

type OAuthConfig

type OAuthConfig struct {
	// The ID of the client sent to the OAuth2 IAM provider.
	ClientId string

	// The OAuth2 realm that the client should operate in. If not applicable, use empty string.
	Realm string

	// The name to display for the application in the authentication popup.
	AppName string
}

OAuthConfig stores configuration for Swagger UI OAuth2 integration. See https://swagger.io/docs/open-source-tools/swagger-ui/usage/oauth2/ for further details.

type SwaggErrDetailsResp

type SwaggErrDetailsResp struct {
	server.ErrorResponse

} // @name SwaggErrDetailsResp

SwaggErrDetailsResp model error response

type SwaggErrResp

type SwaggErrResp struct{} // @name SwaggErrResp

SwaggErrResp error empty response

type SwaggOKResp

type SwaggOKResp struct{} // @name SwaggOKResp

SwaggOKResp success empty response