request

package
v0.4.0-alpha Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 26, 2023 License: MIT Imports: 6 Imported by: 1

Documentation

Index

Constants

View Source
const DefaultContentTypeHeaderValue = "application/x-www-form-urlencoded"

Тип содержимого запроса по умолчанию

Variables

View Source
var AccessTokenParamKey = "access_token"
View Source
var AnonymousTokenKey = "anonymous_token"
View Source
var DefaultBaseRequestUrl = "https://api.vk.com/method/"

URL путь к VK API

View Source
var DeviceIdParamKey = "device_id"
View Source
var LangParamKey = "lang"
View Source
var VersionParamKey = "v"

Functions

This section is empty.

Types

type Params

type Params struct {
	RemoveBlanks bool // Нужно ли удалять ключи с пустыми значениями при сериализации, по умолчанию - false, всегда задавайте самостоятельно как при декодировании из URL, так и при создании нового объекта
	// contains filtered or unexported fields
}

Параметры запроса к API VK Включает в себя как базовые параметры, которые встречаются во всех методах, так и дополнительные параметры.

func NewParams

func NewParams() *Params

Возвращает объект параметров

func NewParamsFromUrl

func NewParamsFromUrl(url url.Values) *Params

Создает объект параметров из url значений или из произвольного map[string][]string

func (Params) AccessToken

func (v Params) AccessToken(token string)

Устанавливает токен доступа

func (Params) AnonymousToken

func (v Params) AnonymousToken(token string)

Устанавливает анонимный токен

func (*Params) ComposeValues

func (v *Params) ComposeValues()

Удаляет пустые значения параметров, если задана настройка RemoveBlanks.

func (Params) Del

func (v Params) Del(key string)

Удаляет значение параметра, аналогично url.Values{}.Del(key)

func (Params) DeviceId

func (v Params) DeviceId(deviceId string)

Устанавливает идентификатор устройства

func (*Params) Get

func (v *Params) Get(key string) string

Возвращает значение параметра по ключу, аналогично url.Values{}.Get(key)

func (*Params) GetAccessToken

func (v *Params) GetAccessToken() string

Возвращает параметр токена доступа

func (*Params) GetAnonymousToken

func (v *Params) GetAnonymousToken() string

Возвращает анонимный токен

func (*Params) GetDeviceId

func (v *Params) GetDeviceId() string

Возвращает идентификатор устройства

func (*Params) GetLang

func (v *Params) GetLang() string

Возвращает язык

func (*Params) GetVersion

func (v *Params) GetVersion() string

Возвращает версию API

func (*Params) Has

func (v *Params) Has(key string) bool

Возвращает информацию о том, есть ли в параметрах значение по указанному ключу, аналогично url.Values{}.Has(key)

func (Params) Lang

func (v Params) Lang(lang string)

Устанавливает язык

func (Params) Set

func (v Params) Set(key, val string)

Перезаписывает ключ существующих параметров, аналогично url.Values{}.Set(key, val)

func (*Params) String

func (v *Params) String() string

Сериализует параметры в строку, предварительно вызывая метод params.ComposeValues()

func (Params) Version

func (v Params) Version(version string)

Устанавливает версию API

type Request

type Request struct {
	// contains filtered or unexported fields
}

Объект запроса к API ВКонткте

func New

func New() *Request

Создает новый API запрос

func (*Request) AppendHeaders

func (v *Request) AppendHeaders(headers http.Header)

Расширяет текущие заголовки. При этом, значение ключа будет перезаписано, если оно уже есть.

func (*Request) GetHeaders

func (v *Request) GetHeaders() http.Header

Headers возвращает копию текущих заголовков запроса

func (*Request) GetMethod

func (v *Request) GetMethod() string

Method возвращает текущий метод запроса

func (*Request) GetParams

func (v *Request) GetParams() *Params

Params возвращает текущий объект параетров

func (*Request) GetRequestUrl

func (v *Request) GetRequestUrl() (*url.URL, error)

Возвращает URL запроса без параметров.

Метод использует значение переменной request.DefaultBaseRequestUrl

func (*Request) Headers

func (v *Request) Headers(headers http.Header)

Устанавливает заголовки, полностью перезаписывает текущие заголовки Заголовок Content-Type при этом не изменяется, так как Request гарантирует одинаковый формат содержимого

func (*Request) HttpRequestGet

func (v *Request) HttpRequestGet() (*http.Request, error)

Возвращает объект запроса для GET метода

func (*Request) HttpRequestPost

func (v *Request) HttpRequestPost() (*http.Request, error)

Возвращает объект запроса для POST метода

func (*Request) Method

func (v *Request) Method(methodName string)

Устанавливает метод VK API и возвращает копию новый запрос

func (*Request) Params

func (v *Request) Params(params *Params)

SetParams устанавливает параметры запроса. Глобальные значения при этом не перезаписываются

func (*Request) String

func (v *Request) String() string

Сериализирует объект запроса в строку для удобного отображения в логах

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL