gotp

package module
v0.0.0-...-733a458 Latest Latest
Warning

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

 Go to latest Published: Apr 17, 2019 License: Apache-2.0 Imports: 3 Imported by: 1

README

proto

目录结构

proto |- common.proto 协议公共定义 |- retcode.proto 返回码定义 |- xxx_server 服务协议目录 |- xxx_service.proto 服务协议定义 |- ......

协议约定

  1. 后台服务接口约定 (1) 接口原型: rpc XXX(XXXRequest) returns (XXXResponse) (2) 命名约定: 请求结构体和响应结构体分别在接口名后增加Request和Response (3) 结构体定义: a. Request和Response结构体分别由header和data两部分组成 message XXXRequest { // Header field "header-field1": xxx, "header-field2": xxx, // Data field XXXRequestData data = 2; }; b. data字段为空时可省略该字段
  2. 前端接口约定 前端使用形如以下描述的HTTP请求访问后台接口 (1) URL: /cgi-bin/version/project/server/service/fucntion, 其中 version - 格式为vN，例如v1，表示接口版本，可用于区分接入层 project - 项目名称，proto文件中package字段的前半部分 server - 服务名，proto文件中package字段的后半部分 service - 对应proto文件中的service名称 function - 对应proto文件中service里定义的接口 (2) Content: JSON字符串，header-field对应接口中的header参数内容，data对应request中data字段 { "header-field1": xxx, "header-field2": xxx, ...... "data": { ...... } } (3) Response: JSON字符串，顶层json为header，内嵌data字段对应response { "retcode" : int, "retmsg" : string, "requestId": string, ...... "data": { ...... } }

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ClientType_name = map[int32]string{
	0:     "Reserve",
	10001: "H5Client",
	10002: "MiniProgramClient",
	10003: "MPClient",
	10004: "APPClient",
}
View Source 
var ClientType_value = map[string]int32{
	"Reserve":           0,
	"H5Client":          10001,
	"MiniProgramClient": 10002,
	"MPClient":          10003,
	"APPClient":         10004,
}
View Source 
var RetcodeType_name = map[int32]string{
	0:      "RetSuccess",
	400001: "RetUnknowError",
	400400: "RetBadRequest",
	400404: "RetNotFound",
	400504: "RetServerError",
	500504: "RetServerUnreachable",
}
View Source 
var RetcodeType_value = map[string]int32{
	"RetSuccess":           0,
	"RetUnknowError":       400001,
	"RetBadRequest":        400400,
	"RetNotFound":          400404,
	"RetServerError":       400504,
	"RetServerUnreachable": 500504,
}

Functions

This section is empty.

Types

type AccessRequestHeader 

type AccessRequestHeader struct {
	//设备id
	ClientId string `protobuf:"bytes,1,opt,name=clientId,proto3" json:"clientId,omitempty"`
	//来源
	ClientType ClientType `protobuf:"varint,2,opt,name=clientType,proto3,enum=gotp.ClientType" json:"clientType,omitempty"`
	//版本号x.y.z，与请求url中的版本不同，此版本为业务协议版本
	Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	//token
	Token                string   `protobuf:"bytes,4,opt,name=token,proto3" json:"token,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

AccessServer可识别header，用于外部请求

func (*AccessRequestHeader) Descriptor 

func (*AccessRequestHeader) Descriptor() ([]byte, []int)

func (*AccessRequestHeader) GetClientId 

func (m *AccessRequestHeader) GetClientId() string

func (*AccessRequestHeader) GetClientType 

func (m *AccessRequestHeader) GetClientType() ClientType

func (*AccessRequestHeader) GetToken 

func (m *AccessRequestHeader) GetToken() string

func (*AccessRequestHeader) GetVersion 

func (m *AccessRequestHeader) GetVersion() string

func (*AccessRequestHeader) ProtoMessage 

func (*AccessRequestHeader) ProtoMessage()

func (*AccessRequestHeader) Reset 

func (m *AccessRequestHeader) Reset()

func (*AccessRequestHeader) String 

func (m *AccessRequestHeader) String() string

func (*AccessRequestHeader) XXX_DiscardUnknown 

func (m *AccessRequestHeader) XXX_DiscardUnknown()

func (*AccessRequestHeader) XXX_Marshal 

func (m *AccessRequestHeader) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AccessRequestHeader) XXX_Merge 

func (m *AccessRequestHeader) XXX_Merge(src proto.Message)

func (*AccessRequestHeader) XXX_Size 

func (m *AccessRequestHeader) XXX_Size() int

func (*AccessRequestHeader) XXX_Unmarshal 

func (m *AccessRequestHeader) XXX_Unmarshal(b []byte) error

type AccessResponseHeader 

type AccessResponseHeader struct {
	//业务返回码
	Retcode int32 `protobuf:"varint,1,opt,name=retcode,proto3" json:"retcode,omitempty"`
	//业务返回消息
	Retmsg string `protobuf:"bytes,2,opt,name=retmsg,proto3" json:"retmsg,omitempty"`
	//请求id
	RequestId            string   `protobuf:"bytes,3,opt,name=requestId,proto3" json:"requestId,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*AccessResponseHeader) Descriptor 

func (*AccessResponseHeader) Descriptor() ([]byte, []int)

func (*AccessResponseHeader) GetRequestId 

func (m *AccessResponseHeader) GetRequestId() string

func (*AccessResponseHeader) GetRetcode 

func (m *AccessResponseHeader) GetRetcode() int32

func (*AccessResponseHeader) GetRetmsg 

func (m *AccessResponseHeader) GetRetmsg() string

func (*AccessResponseHeader) ProtoMessage 

func (*AccessResponseHeader) ProtoMessage()

func (*AccessResponseHeader) Reset 

func (m *AccessResponseHeader) Reset()

func (*AccessResponseHeader) String 

func (m *AccessResponseHeader) String() string

func (*AccessResponseHeader) XXX_DiscardUnknown 

func (m *AccessResponseHeader) XXX_DiscardUnknown()

func (*AccessResponseHeader) XXX_Marshal 

func (m *AccessResponseHeader) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AccessResponseHeader) XXX_Merge 

func (m *AccessResponseHeader) XXX_Merge(src proto.Message)

func (*AccessResponseHeader) XXX_Size 

func (m *AccessResponseHeader) XXX_Size() int

func (*AccessResponseHeader) XXX_Unmarshal 

func (m *AccessResponseHeader) XXX_Unmarshal(b []byte) error

type ClientType 

type ClientType int32
const (
	ClientType_Reserve           ClientType = 0
	ClientType_H5Client          ClientType = 10001
	ClientType_MiniProgramClient ClientType = 10002
	ClientType_MPClient          ClientType = 10003
	ClientType_APPClient         ClientType = 10004
)

func (ClientType) EnumDescriptor 

func (ClientType) EnumDescriptor() ([]byte, []int)

func (ClientType) String 

func (x ClientType) String() string

type RequestHeader 

type RequestHeader struct {
	//请求id
	RequestId string `protobuf:"bytes,1,opt,name=requestId,proto3" json:"requestId,omitempty"`
	//设备id
	ClientId string `protobuf:"bytes,2,opt,name=clientId,proto3" json:"clientId,omitempty"`
	//来源
	ClientType int32 `protobuf:"varint,3,opt,name=clientType,proto3" json:"clientType,omitempty"`
	//版本号x.y.z，与请求url中的版本不同，此版本为业务协议版本
	Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
	//测试标志位
	TestFlag             bool     `protobuf:"varint,5,opt,name=testFlag,proto3" json:"testFlag,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

用于内部RPC请求

func (*RequestHeader) Descriptor 

func (*RequestHeader) Descriptor() ([]byte, []int)

func (*RequestHeader) GetClientId 

func (m *RequestHeader) GetClientId() string

func (*RequestHeader) GetClientType 

func (m *RequestHeader) GetClientType() int32

func (*RequestHeader) GetRequestId 

func (m *RequestHeader) GetRequestId() string

func (*RequestHeader) GetTestFlag 

func (m *RequestHeader) GetTestFlag() bool

func (*RequestHeader) GetVersion 

func (m *RequestHeader) GetVersion() string

func (*RequestHeader) ProtoMessage 

func (*RequestHeader) ProtoMessage()

func (*RequestHeader) Reset 

func (m *RequestHeader) Reset()

func (*RequestHeader) String 

func (m *RequestHeader) String() string

func (*RequestHeader) XXX_DiscardUnknown 

func (m *RequestHeader) XXX_DiscardUnknown()

func (*RequestHeader) XXX_Marshal 

func (m *RequestHeader) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RequestHeader) XXX_Merge 

func (m *RequestHeader) XXX_Merge(src proto.Message)

func (*RequestHeader) XXX_Size 

func (m *RequestHeader) XXX_Size() int

func (*RequestHeader) XXX_Unmarshal 

func (m *RequestHeader) XXX_Unmarshal(b []byte) error

type ResponseHeader 

type ResponseHeader struct {
	//业务返回码
	Retcode int32 `protobuf:"varint,1,opt,name=retcode,proto3" json:"retcode,omitempty"`
	//业务返回消息
	Retmsg string `protobuf:"bytes,2,opt,name=retmsg,proto3" json:"retmsg,omitempty"`
	//请求id
	RequestId            string   `protobuf:"bytes,3,opt,name=requestId,proto3" json:"requestId,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*ResponseHeader) Descriptor 

func (*ResponseHeader) Descriptor() ([]byte, []int)

func (*ResponseHeader) GetRequestId 

func (m *ResponseHeader) GetRequestId() string

func (*ResponseHeader) GetRetcode 

func (m *ResponseHeader) GetRetcode() int32

func (*ResponseHeader) GetRetmsg 

func (m *ResponseHeader) GetRetmsg() string

func (*ResponseHeader) ProtoMessage 

func (*ResponseHeader) ProtoMessage()

func (*ResponseHeader) Reset 

func (m *ResponseHeader) Reset()

func (*ResponseHeader) String 

func (m *ResponseHeader) String() string

func (*ResponseHeader) XXX_DiscardUnknown 

func (m *ResponseHeader) XXX_DiscardUnknown()

func (*ResponseHeader) XXX_Marshal 

func (m *ResponseHeader) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ResponseHeader) XXX_Merge 

func (m *ResponseHeader) XXX_Merge(src proto.Message)

func (*ResponseHeader) XXX_Size 

func (m *ResponseHeader) XXX_Size() int

func (*ResponseHeader) XXX_Unmarshal 

func (m *ResponseHeader) XXX_Unmarshal(b []byte) error

type RetcodeType 

type RetcodeType int32
const (
	//------------ common ---------------
	RetcodeType_RetSuccess RetcodeType = 0
	//------------ system 4xxxxx ---------------
	RetcodeType_RetUnknowError RetcodeType = 400001
	RetcodeType_RetBadRequest  RetcodeType = 400400
	RetcodeType_RetNotFound    RetcodeType = 400404
	RetcodeType_RetServerError RetcodeType = 400504
	//------------- access 5xxxxx --------
	RetcodeType_RetServerUnreachable RetcodeType = 500504
)

func (RetcodeType) EnumDescriptor 

func (RetcodeType) EnumDescriptor() ([]byte, []int)

func (RetcodeType) String 

func (x RetcodeType) String() string

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.