Function BasicAuthSecurity

dsl/security.go:20–44

BasicAuthSecurity defines a basic authentication security scheme. BasicAuthSecurity is a top level DSL. BasicAuthSecurity takes a name as first argument and an optional DSL as second argument. Example: var Basic = BasicAuthSecurity("basicauth", func() { Description("Use your own password!"

(name string, fn ...func())

//	    Description("Use your own password!")
//	})
func BasicAuthSecurity(name string, fn ...func()) *expr.SchemeExpr {
	if _, ok := eval.Current().(eval.TopExpr); !ok {
		eval.IncompatibleDSL()
		return nil
	}

	if securitySchemeRedefined(name) {
		return nil
	}

	e := &expr.SchemeExpr{
		Kind:       expr.BasicAuthKind,
		SchemeName: name,
	}

	if len(fn) != 0 {
		if !eval.Execute(fn[0], e) {
			return nil
		}
	}

	expr.Root.Schemes = append(expr.Root.Schemes, e)

	return e
}

// APIKeySecurity defines an API key security scheme where a key must be
// provided by the client to perform authorization.