runtime

Documentation

Overview

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 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 MarshalDeepObject(i interface{}, paramName string) (string, error)
• func StyleParam(style string, explode bool, paramName string, value interface{}) (string, error)
• func UnmarshalDeepObject(dst interface{}, paramName string, params url.Values) error

Functions

func BindQueryParameter

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

This 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 echo 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.

func BindStringToObject

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

This function 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.

func BindStyledParameter

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

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

func MarshalDeepObject

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

func StyleParam

func StyleParam(style string, explode bool, paramName string, 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.

func UnmarshalDeepObject

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