model

Documentation

Overview

Package model 包含API所需结构体

Index

• type BaseResponse
  • func (r BaseResponse) Error() string
  • func (r BaseResponse) IsError() bool
• type FloatRange
• type Geolocation
• type GetRequest
• type PageInfo
• type PostRequest
• type Response
• type UploadField
• type UploadRequest

Types

type BaseResponse

type BaseResponse struct {
	// Code 返回码
	Code int `json:"code,omitempty"`
	// Message 返回信息
	Message string `json:"message,omitempty"`
	// RequestID 请求的日志id，唯一标识一个请求
	RequestID string `json:"request_id,omitempty"`
}

BaseResponse shared api response data fields

func (BaseResponse) Error

func (r BaseResponse) Error() string

Error implement Response interface

func (BaseResponse) IsError

func (r BaseResponse) IsError() bool

IsError implement Response interface

type FloatRange

type FloatRange struct {
	Min float64
	Max float64
}

FloatRange 通用浮点数字范围

type Geolocation

type Geolocation struct {
	// Radius 半径
	Radius int64 `json:"radius,omitempty"`
	// Name 地点名称
	Name string `json:"name,omitempty"`
	// Long 经度
	Long float64 `json:"long,omitempty"`
	// Lat 纬度
	Lat float64 `json:"lat,omitempty"`
	// City 城市名
	City string `json:"city,omitempty"`
	// StreetNumber 街道号
	StreetNumber string `json:"street_number,omitempty"`
	// Street 街道名
	Street string `json:"street,omitempty"`
	// District 区域名
	District string `json:"district,omitempty"`
	// Province 省份名
	Province string `json:"province,omitempty"`
}

Geolocation 地理位置信息

type GetRequest

type GetRequest interface {
	// Encode encode request to string
	Encode() string
}

GetRequest get request interface

type PageInfo

type PageInfo struct {
	// Page 当前页码
	Page int `json:"page,omitempty"`
	// PageSize 每页item个数
	PageSize int `json:"page_size,omitempty"`
	// TotalNumber 总item个数
	TotalNumber int64 `json:"total_number,omitempty"`
	// TotalPage 总页数
	TotalPage int `json:"total_page,omitempty"`
}

PageInfo 通用翻页数据

type PostRequest

type PostRequest interface {
	// Encode encode request to bytes
	Encode() []byte
}

PostRequest post request interface

type Response

type Response interface {
	// IsError 是否返回错误
	IsError() bool
	// Error implement error interface
	Error() string
}

Response api response interface

type UploadField

type UploadField struct {
	// Key field key
	Key string
	// Value field value
	Value string
	// Reader upload file reader
	Reader io.Reader
}

UploadField multipart/form-data post request field struct

type UploadRequest

type UploadRequest interface {
	// Encode encode request to UploadFields
	Encode() []UploadField
}

UploadRequest multipart/form-data reqeust interface