model

package

v1.2.2 Latest Latest Go to latest Published: Jul 6, 2021 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bububa/opentaobao

Links

Open Source Insights

Documentation ¶

Overview ¶

Package model 包含API请求及返回对象结构体

Index ¶

Constants
func AnyToString(val interface{}) (string, error)
type APIFormat
type CommonRequest
- func NewCommonRequest(method string, appKey string) *CommonRequest
- func (c CommonRequest) GetParams() map[string]string
- func (c *CommonRequest) SetAPIFormat(format APIFormat)
- func (c *CommonRequest) SetSession(session string)
- func (c *CommonRequest) SetSignMethod(method SignMethod)
type CommonResponse
- func (c CommonResponse) B043C16EB094F65A787F22E6AE0A10BCB7ABDE6D() error
type ErrorResponse
- func (c ErrorResponse) Error() string
type File
- func (f File) MultipartFileName() string
type IRequest
type IResponse
type ParamValue
- func NewFileParamValue(fd *File) *ParamValue
- func NewStringParamValue(str string) *ParamValue
- func (p ParamValue) File() *File
- func (p ParamValue) IsFile() bool
- func (p ParamValue) String() string
type Params
- func NewParams() Params
- func (p Params) GetRawParams() map[string]*ParamValue
- func (p Params) NeedMultipart() bool
- func (p Params) Set(key string, value interface{}) error
type SignMethod

Constants ¶

View Source

const (

	// DEFAULT_SIGN_METHOD 默认签名方法
	DEFAULT_SIGN_METHOD = MD5

	// DEFAULT_API_VERSION 默认API版本
	DEFAULT_API_VERSION = "2.0"

	// DEFAULT_API_FORMAT 默认api返回格式
	DEFAULT_API_FORMAT = JSON
)

Variables ¶

This section is empty.

Functions ¶

func AnyToString ¶

func AnyToString(val interface{}) (string, error)

AnyToString 转换任意类型参数值为string

Types ¶

type APIFormat ¶

type APIFormat = string

APIFormat API请求及返回格式

const (

	// JSON json api format
	JSON APIFormat = "json"

	// XML xml api format
	XML APIFormat = "xml"
)

type CommonRequest ¶

type CommonRequest struct {
	Method       string    `json:"method,omitempty"`         // API接口名称
	AppKey       string    `json:"app_key,omitempty"`        // TOP分配给应用的AppKey
	TargetAppKey string    `json:"target_app_key,omitempty"` // 被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效
	SignMethod   string    `json:"sign_method,omitempty"`    // 签名的摘要算法，可选值为：hmac，md5，hmac-sha256。
	Session      string    `json:"session,omitempty"`        // 用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选
	Timestamp    string    `json:"timestamp,omitempty"`      // 时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟
	Format       APIFormat `json:"format,omitempty"`         // 响应格式。默认为xml格式，可选值：xml，json。
	V            string    `json:"v,omitempty"`              // API协议版本，可选值：2.0
	PartnerId    string    `json:"partner_id,omitempty"`     // 合作伙伴身份标识
	Simplify     bool      `json:"simplify,omitempty"`       // 是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false
}

CommonRequest API请求通用参数

func NewCommonRequest ¶

func NewCommonRequest(method string, appKey string) *CommonRequest

NewCommonRequest 新建API请求通用参数

func (CommonRequest) GetParams ¶

func (c CommonRequest) GetParams() map[string]string

GetParams 转换通用请求参数为map[string]string

func (*CommonRequest) SetAPIFormat ¶

func (c *CommonRequest) SetAPIFormat(format APIFormat)

SetAPIFormat 设置API格式

func (*CommonRequest) SetSession ¶

func (c *CommonRequest) SetSession(session string)

SetSession 设置access_session

func (*CommonRequest) SetSignMethod ¶

func (c *CommonRequest) SetSignMethod(method SignMethod)

SetSignMethod 设置签名方法

type CommonResponse ¶

type CommonResponse struct {
	ErrorResponse *ErrorResponse `json:"error_response,omitempty" xml:"error_response,omitempty"` // 请求访问失败时返回的根节点
}

CommonResponse 通用返回参数

func (CommonResponse) B043C16EB094F65A787F22E6AE0A10BCB7ABDE6D ¶

func (c CommonResponse) B043C16EB094F65A787F22E6AE0A10BCB7ABDE6D() error

B043C16EB094F65A787F22E6AE0A10BCB7ABDE6D implement IResponse interface

type ErrorResponse ¶

type ErrorResponse struct {
	XMLName   xml.Name `xml:"error_response"`
	RequestId string   `json:"request_id,omitempty" xml:"request_id,omitempty"` // 平台颁发的每次请求访问的唯一标识
	Msg       string   `json:"msg,omitempty" xml:"msg,omitempty"`               // 请求失败返回的错误信息
	SubCode   string   `json:"sub_code,omitempty" xml:"sub_code,omitempty"`     // 请求失败返回的子错误码
	SubMsg    string   `json:"sub_msg,omitempty" xml:"sub_msg,omitempty"`       // 请求失败返回的子错误信息
	Code      int      `json:"code,omitempty" xml:"code,omitempty"`             // 请求失败返回的错误码
}

ErrorResponse API请求失败Error结构体

func (ErrorResponse) Error ¶

func (c ErrorResponse) Error() string

Error implement Error interface

type File ¶

type File struct {
	io.Reader
	Name string
}

File 用于上传文件，对应淘宝API中byte[]类型

func (File) MultipartFileName ¶

func (f File) MultipartFileName() string

MultipartFileName multipart/form 中文件名

type IRequest ¶

type IRequest interface {
	GetApiMethodName() string
	GetApiParams() url.Values
	NeedMultipart() bool
	GetRawParams() map[string]*ParamValue
}

IRequest is API Request interace

type IResponse ¶

type IResponse interface {
	B043C16EB094F65A787F22E6AE0A10BCB7ABDE6D() error
}

IResponse is API Response interace

type ParamValue ¶ added in v1.2.0

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

ParamValue 为APIRequest中的参数值

func NewFileParamValue ¶ added in v1.2.0

func NewFileParamValue(fd *File) *ParamValue

NewFileParamValue 新建File类型值

func NewStringParamValue ¶ added in v1.2.0

func NewStringParamValue(str string) *ParamValue

NewStringParamValue 新建string类型值

func (ParamValue) File ¶ added in v1.2.0

func (p ParamValue) File() *File

File 返回参数文件

func (ParamValue) IsFile ¶ added in v1.2.0

func (p ParamValue) IsFile() bool

IsFile 判断参数值是否为文件

func (ParamValue) String ¶ added in v1.2.0

func (p ParamValue) String() string

String 文件类型则返回文件名，string类型返回string

type Params ¶

type Params map[string]*ParamValue

Params 为APIRequest中的参数列表

func NewParams ¶

func NewParams() Params

NewParams 新建API参数列表对象

func (Params) GetRawParams ¶

func (p Params) GetRawParams() map[string]*ParamValue

GetRawParams 返回参数map

func (Params) NeedMultipart ¶

func (p Params) NeedMultipart() bool

NeedMultipart 判断是否需要使用form/multipart post

func (Params) Set ¶

func (p Params) Set(key string, value interface{}) error

Set 添加APIRequest参数

type SignMethod ¶

type SignMethod = string

SignMethod API签名方法

const (

	// MD5 md5 sign method
	MD5 SignMethod = "md5"

	// HMAC hmac sign method
	HMAC SignMethod = "hmac"
)

Source Files ¶

View all Source files

Directories ¶

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

Path	Synopsis
admarket Package admarket 包含ALIOS广告平台相关结构体 https://open.taobao.com/API.htm?docId=37669&docType=2	Package admarket 包含ALIOS广告平台相关结构体 https://open.taobao.com/API.htm?docId=37669&docType=2
aecreatives Package aecreatives 包含Promotion Creatives相关结构体 https://open.taobao.com/API.htm?docId=45801&docType=2	Package aecreatives 包含Promotion Creatives相关结构体 https://open.taobao.com/API.htm?docId=45801&docType=2
aedata Package aedata 包含Data Reports相关结构体 https://open.taobao.com/API.htm?docId=45807&docType=2	Package aedata 包含Data Reports相关结构体 https://open.taobao.com/API.htm?docId=45807&docType=2
aedropshiper Package aedropshiper 包含AE-Dropshipper相关结构体 https://open.taobao.com/API.htm?docId=39371&docType=2	Package aedropshiper 包含AE-Dropshipper相关结构体 https://open.taobao.com/API.htm?docId=39371&docType=2
aesolution Package aesolution 包含AE-Oversea-Solution相关结构体 https://open.taobao.com/API.htm?docId=47378&docType=2	Package aesolution 包含AE-Oversea-Solution相关结构体 https://open.taobao.com/API.htm?docId=47378&docType=2
aetask Package aetask 包含AE任务开放平台相关结构体 https://open.taobao.com/API.htm?docId=53415&docType=2	Package aetask 包含AE任务开放平台相关结构体 https://open.taobao.com/API.htm?docId=53415&docType=2
aetools Package aetools 包含Efficient Tools相关结构体 https://open.taobao.com/API.htm?docId=45804&docType=2	Package aetools 包含Efficient Tools相关结构体 https://open.taobao.com/API.htm?docId=45804&docType=2
aeusergrowth Package aeusergrowth 包含AE-UserOpen-Recommend相关结构体 https://open.taobao.com/API.htm?docId=45722&docType=2	Package aeusergrowth 包含AE-UserOpen-Recommend相关结构体 https://open.taobao.com/API.htm?docId=45722&docType=2
aiar Package aiar 包含AILAB图像算法API相关结构体 https://open.taobao.com/API.htm?docId=37057&docType=2	Package aiar 包含AILAB图像算法API相关结构体 https://open.taobao.com/API.htm?docId=37057&docType=2
alicom Package alicom 包含阿里通信API相关结构体 https://open.taobao.com/API.htm?docId=29701&docType=2	Package alicom 包含阿里通信API相关结构体 https://open.taobao.com/API.htm?docId=29701&docType=2
alidoc Package alidoc 包含阿里健康处方药平台相关结构体 https://open.taobao.com/API.htm?docId=44810&docType=2	Package alidoc 包含阿里健康处方药平台相关结构体 https://open.taobao.com/API.htm?docId=44810&docType=2
aliexpress Package aliexpress 包含aliExpress相关结构体 https://open.taobao.com/API.htm?docId=54728&docType=2	Package aliexpress 包含aliExpress相关结构体 https://open.taobao.com/API.htm?docId=54728&docType=2
aliexpresssumaitong Package aliexpresssumaitong 包含全球速卖通相关结构体 https://open.taobao.com/API.htm?docId=56229&docType=2	Package aliexpresssumaitong 包含全球速卖通相关结构体 https://open.taobao.com/API.htm?docId=56229&docType=2
aligenie Package aligenie 包含阿里精灵基础能力接口相关结构体 https://open.taobao.com/API.htm?docId=39668&docType=2	Package aligenie 包含阿里精灵基础能力接口相关结构体 https://open.taobao.com/API.htm?docId=39668&docType=2
alihealth Package alihealth 包含阿里健康医相关结构体 https://open.taobao.com/API.htm?docId=42645&docType=2	Package alihealth 包含阿里健康医相关结构体 https://open.taobao.com/API.htm?docId=42645&docType=2
alihealth2 Package alihealth2 包含阿里健康API相关结构体 https://open.taobao.com/API.htm?docId=43381&docType=2	Package alihealth2 包含阿里健康API相关结构体 https://open.taobao.com/API.htm?docId=43381&docType=2
alihealthalgo Package alihealthalgo 包含阿里健康算法相关结构体 https://open.taobao.com/API.htm?docId=48492&docType=2	Package alihealthalgo 包含阿里健康算法相关结构体 https://open.taobao.com/API.htm?docId=48492&docType=2
alihealthcert Package alihealthcert 包含阿里健康-健康证相关结构体 https://open.taobao.com/API.htm?docId=54140&docType=2	Package alihealthcert 包含阿里健康-健康证相关结构体 https://open.taobao.com/API.htm?docId=54140&docType=2
alihealthcrm Package alihealthcrm 包含阿里健康-会员管理相关结构体 https://open.taobao.com/API.htm?docId=46804&docType=2	Package alihealthcrm 包含阿里健康-会员管理相关结构体 https://open.taobao.com/API.htm?docId=46804&docType=2
alihealthlab Package alihealthlab 包含阿里健康-检测检验-预约相关结构体 https://open.taobao.com/API.htm?docId=51444&docType=2	Package alihealthlab 包含阿里健康-检测检验-预约相关结构体 https://open.taobao.com/API.htm?docId=51444&docType=2
alihealthmdeer Package alihealthmdeer 包含医知鹿-视频相关结构体 https://open.taobao.com/API.htm?docId=46849&docType=2	Package alihealthmdeer 包含医知鹿-视频相关结构体 https://open.taobao.com/API.htm?docId=46849&docType=2
alihealthmedical Package alihealthmedical 包含阿里健康三方机构相关结构体 https://open.taobao.com/API.htm?docId=51290&docType=2	Package alihealthmedical 包含阿里健康三方机构相关结构体 https://open.taobao.com/API.htm?docId=51290&docType=2
alihealthoutflow Package alihealthoutflow 包含阿里健康医生相关结构体 https://open.taobao.com/API.htm?docId=43570&docType=2	Package alihealthoutflow 包含阿里健康医生相关结构体 https://open.taobao.com/API.htm?docId=43570&docType=2
alihealthpw Package alihealthpw 包含阿里健康公益线API相关结构体 https://open.taobao.com/API.htm?docId=56009&docType=2	Package alihealthpw 包含阿里健康公益线API相关结构体 https://open.taobao.com/API.htm?docId=56009&docType=2
alihouse Package alihouse 包含天猫好房工具API相关结构体 https://open.taobao.com/API.htm?docId=56032&docType=2	Package alihouse 包含天猫好房工具API相关结构体 https://open.taobao.com/API.htm?docId=56032&docType=2
alilabs Package alilabs 包含人工智能实验室开放平台API相关结构体 https://open.taobao.com/API.htm?docId=45531&docType=2	Package alilabs 包含人工智能实验室开放平台API相关结构体 https://open.taobao.com/API.htm?docId=45531&docType=2
alime Package alime 包含小蜜API相关结构体 https://open.taobao.com/API.htm?docId=44065&docType=2	Package alime 包含小蜜API相关结构体 https://open.taobao.com/API.htm?docId=44065&docType=2
alimember Package alimember 包含全域会员通相关结构体 https://open.taobao.com/API.htm?docId=46937&docType=2	Package alimember 包含全域会员通相关结构体 https://open.taobao.com/API.htm?docId=46937&docType=2
alimsg Package alimsg 包含消息API相关结构体 https://open.taobao.com/API.htm?docId=56166&docType=2	Package alimsg 包含消息API相关结构体 https://open.taobao.com/API.htm?docId=56166&docType=2
alink Package alink 包含物联API相关结构体 https://open.taobao.com/API.htm?docId=28313&docType=2	Package alink 包含物联API相关结构体 https://open.taobao.com/API.htm?docId=28313&docType=2
aliospay Package aliospay 包含AliOS支付API相关结构体 https://open.taobao.com/API.htm?docId=45261&docType=2	Package aliospay 包含AliOS支付API相关结构体 https://open.taobao.com/API.htm?docId=45261&docType=2
aliqin Package aliqin 包含阿里大于API相关结构体 https://open.taobao.com/API.htm?docId=28647&docType=2	Package aliqin 包含阿里大于API相关结构体 https://open.taobao.com/API.htm?docId=28647&docType=2
alisports Package alisports 包含阿里体育API相关结构体 https://open.taobao.com/API.htm?docId=41267&docType=2	Package alisports 包含阿里体育API相关结构体 https://open.taobao.com/API.htm?docId=41267&docType=2
alitripbp Package alitripbp 包含飞猪商业化API相关结构体 https://open.taobao.com/API.htm?docId=55665&docType=2	Package alitripbp 包含飞猪商业化API相关结构体 https://open.taobao.com/API.htm?docId=55665&docType=2
alitripcar Package alitripcar 包含飞猪-综合交通api相关结构体 https://open.taobao.com/API.htm?docId=53101&docType=2	Package alitripcar 包含飞猪-综合交通api相关结构体 https://open.taobao.com/API.htm?docId=53101&docType=2
alitripdivisions Package alitripdivisions 包含飞猪行政区划API相关结构体 https://open.taobao.com/API.htm?docId=31375&docType=2	Package alitripdivisions 包含飞猪行政区划API相关结构体 https://open.taobao.com/API.htm?docId=31375&docType=2
alitripmerchant Package alitripmerchant 包含飞猪商家平台相关结构体 https://open.taobao.com/API.htm?docId=54748&docType=2	Package alitripmerchant 包含飞猪商家平台相关结构体 https://open.taobao.com/API.htm?docId=54748&docType=2
alitrippoi Package alitrippoi 包含飞猪POI数据API相关结构体 https://open.taobao.com/API.htm?docId=45315&docType=2	Package alitrippoi 包含飞猪POI数据API相关结构体 https://open.taobao.com/API.htm?docId=45315&docType=2
alitripreceipt Package alitripreceipt 包含飞猪发票相关结构体 https://open.taobao.com/API.htm?docId=51546&docType=2	Package alitripreceipt 包含飞猪发票相关结构体 https://open.taobao.com/API.htm?docId=51546&docType=2
aliyun Package aliyun 包含阿里云API相关结构体 https://open.taobao.com/API.htm?docId=24304&docType=2	Package aliyun 包含阿里云API相关结构体 https://open.taobao.com/API.htm?docId=24304&docType=2