runtime

Documentation

Overview

Copyright 2021 DeepMap, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2019 DeepMap, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2019 DeepMap, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2019 DeepMap, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func BindForm(ptr interface{}, form map[string][]string, ...) error
• func BindMultipart(ptr interface{}, reader multipart.Reader) error
• func BindQueryParameter(style string, explode bool, required bool, paramName string, ...) error
• func BindStringToObject(src string, dst interface{}) error
• func BindStyledParameter(style string, explode bool, paramName string, value string, dest interface{}) error
• func BindStyledParameterWithLocation(style string, explode bool, paramName string, paramLocation ParamLocation, ...) error
• func JsonMerge(data, patch json.RawMessage) (json.RawMessage, error)
• func MarshalDeepObject(i interface{}, paramName string) (string, error)
• func MarshalForm(ptr interface{}, encodings map[string]RequestBodyEncoding) (url.Values, error)
• func StyleParam(style string, explode bool, paramName string, value interface{}) (string, error)
• func StyleParamWithLocation(style string, explode bool, paramName string, paramLocation ParamLocation, ...) (string, error)
• func UnmarshalDeepObject(dst interface{}, paramName string, params url.Values) error
• type Binder
• type ParamLocation
• type RequestBodyEncoding
• type StrictEchoHandlerFunc
• type StrictEchoMiddlewareFunc
• type StrictGinHandlerFunc
• type StrictGinMiddlewareFunc
• type StrictHttpHandlerFunc
• type StrictHttpMiddlewareFunc
• type StrictIrisHandlerFunc
• type StrictIrisMiddlewareFunc

Functions

func BindForm

func BindForm(ptr interface{}, form map[string][]string, files map[string][]*multipart.FileHeader, encodings map[string]RequestBodyEncoding) error

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime#BindForm

func BindMultipart

func BindMultipart(ptr interface{}, reader multipart.Reader) error

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime#BindMultipart

func BindQueryParameter

func BindQueryParameter(style string, explode bool, required bool, paramName string,
	queryParams url.Values, dest interface{}) error

BindQueryParameter works much like BindStyledParameter, however it takes a query argument input array from the url package, since query arguments come through a different path than the styled arguments. They're also exceptionally fussy. For example, consider the exploded and unexploded form parameter examples: (exploded) /users?role=admin&firstName=Alex (unexploded) /users?id=role,admin,firstName,Alex

In the first case, we can pull the "id" parameter off the context, and unmarshal via json as an intermediate. Easy. In the second case, we don't have the id QueryParam present, but must find "role", and "firstName". what if there is another parameter similar to "ID" named "role"? We can't tell them apart. This code tries to fail, but the moral of the story is that you shouldn't pass objects via form styled query arguments, just use the Content parameter form.

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime#BindQueryParameter

func BindStringToObject

func BindStringToObject(src string, dst interface{}) error

BindStringToObject takes a string, and attempts to assign it to the destination interface via whatever type conversion is necessary. We have to do this via reflection instead of a much simpler type switch so that we can handle type aliases. This function was the easy way out, the better way, since we know the destination type each place that we use this, is to generate code to read each specific type.

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime#BindStringToObject

func BindStyledParameter

func BindStyledParameter(style string, explode bool, paramName string,
	value string, dest interface{}) error

BindStyledParameter binds a parameter as described in the Path Parameters section here to a Go object: https://swagger.io/docs/specification/serialization/ It is a backward compatible function to clients generated with codegen up to version v1.5.5. v1.5.6+ calls the function below.

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime#BindStyledParameter

func BindStyledParameterWithLocation

func BindStyledParameterWithLocation(style string, explode bool, paramName string,
	paramLocation ParamLocation, value string, dest interface{}) error

BindStyledParameterWithLocation binds a parameter as described in the Path Parameters section here to a Go object: https://swagger.io/docs/specification/serialization/

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime#BindStyledParameterWithLocation

func JsonMerge

func JsonMerge(data, patch json.RawMessage) (json.RawMessage, error)

JsonMerge merges two JSON representation into a single object. `data` is the existing representation and `patch` is the new data to be merged in

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime#JsonMerge

func MarshalDeepObject

func MarshalDeepObject(i interface{}, paramName string) (string, error)

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime#MarshalDeepObject

func MarshalForm

func MarshalForm(ptr interface{}, encodings map[string]RequestBodyEncoding) (url.Values, error)

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime#MarshalForm

func StyleParam

func StyleParam(style string, explode bool, paramName string, value interface{}) (string, error)

StyleParam is used by older generated code, and must remain compatible with that code. It is not to be used in new templates. Please see the function below, which can specialize its output based on the location of the parameter.

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime#StyleParam

func StyleParamWithLocation

func StyleParamWithLocation(style string, explode bool, paramName string, paramLocation ParamLocation, value interface{}) (string, error)

Given an input value, such as a primitive type, array or object, turn it into a parameter based on style/explode definition, performing whatever escaping is necessary based on parameter location

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime#StyleParam

func UnmarshalDeepObject

func UnmarshalDeepObject(dst interface{}, paramName string, params url.Values) error

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime#UnmarshalDeepObject

Types

type Binder

type Binder interface {
	Bind(src string) error
}

Binder is the interface implemented by types that can be bound to a query string or a parameter string The input can be assumed to be a valid string. If you define a Bind method you are responsible for all data being completely bound to the type.

By convention, to approximate the behavior of Bind functions themselves, Binder implements Bind("") as a no-op.

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime#Binder

type ParamLocation

type ParamLocation int

Parameter escaping works differently based on where a header is found

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime#ParamLocation

const (
	ParamLocationUndefined ParamLocation = iota
	ParamLocationQuery
	ParamLocationPath
	ParamLocationHeader
	ParamLocationCookie
)

type RequestBodyEncoding

type RequestBodyEncoding struct {
	ContentType string
	Style       string
	Explode     *bool
}

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime#RequestBodyEncoding

type StrictEchoHandlerFunc

type StrictEchoHandlerFunc func(ctx echo.Context, request interface{}) (response interface{}, err error)

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime/strictmiddleware/echo#StrictEchoHandlerFunc

type StrictEchoMiddlewareFunc

type StrictEchoMiddlewareFunc func(f StrictEchoHandlerFunc, operationID string) StrictEchoHandlerFunc

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime/strictmiddleware/echo#StrictEchoMiddlewareFunc

type StrictGinHandlerFunc

type StrictGinHandlerFunc func(ctx *gin.Context, request interface{}) (response interface{}, err error)

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime/strictmiddleware/gin#StrictGinHandlerFunc

type StrictGinMiddlewareFunc

type StrictGinMiddlewareFunc func(f StrictGinHandlerFunc, operationID string) StrictGinHandlerFunc

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime/strictmiddleware/gin#StrictGinMiddlewareFunc

type StrictHttpHandlerFunc

type StrictHttpHandlerFunc func(ctx context.Context, w http.ResponseWriter, r *http.Request, request interface{}) (response interface{}, err error)

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime/strictmiddleware/nethttp#StrictHttpHandlerFunc

type StrictHttpMiddlewareFunc

type StrictHttpMiddlewareFunc func(f StrictHttpHandlerFunc, operationID string) StrictHttpHandlerFunc

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime/strictmiddleware/nethttp#StrictHttpMiddlewareFunc

type StrictIrisHandlerFunc

type StrictIrisHandlerFunc func(ctx iris.Context, request interface{}) (response interface{}, err error)

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime/strictmiddleware/iris#StrictIrisHandlerFunc

type StrictIrisMiddlewareFunc

type StrictIrisMiddlewareFunc func(f StrictIrisHandlerFunc, operationID string) StrictIrisHandlerFunc

Deprecated: This has been replaced by https://pkg.go.dev/github.com/oapi-codegen/runtime/strictmiddleware/iris#StrictIrisMiddlewareFunc