Function APIKeySecurity

dsl/security.go:59–83

APIKeySecurity defines an API key security scheme where a key must be provided by the client to perform authorization. APIKeySecurity is a top level DSL. APIKeySecurity takes a name as first argument and an optional DSL as second argument. Example: var APIKey = APIKeySecurity("key", func() {

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

//	      Description("Shared secret")
//	})
func APIKeySecurity(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.APIKeyKind,
		SchemeName: name,
	}

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

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

	return e
}

// OAuth2Security defines an OAuth2 security scheme. The DSL provided as second
// argument defines the specific flows supported by the scheme. The supported