Protocol Documentation

Table of Contents

api/serverNameExample/v1/userExample.proto

Top

CreateUserExampleReply

FieldTypeLabelDescription
id uint64

CreateUserExampleRequest

FieldTypeLabelDescription
name string

name

email string

email

password string

password

phone string

phone number

avatar string

avatar

age int32

age

gender GenderType

gender, 1:Male, 2:Female, other values:unknown

Validated Fields

Field Validations
name
  • string.min_len: 2
email
  • string.email: true
password
  • string.min_len: 10
phone
  • string.pattern: ^1[3456789]\d{9}$
avatar
  • string.uri: true
age
  • int32.lte: 120
  • int32.gte: 0
gender
  • enum.defined_only: true

DeleteUserExampleByIDReply

DeleteUserExampleByIDRequest

FieldTypeLabelDescription
id uint64

Validated Fields

Field Validations
id
  • uint64.gte: 1

GetUserExampleByIDReply

FieldTypeLabelDescription
userExample UserExample

GetUserExampleByIDRequest

FieldTypeLabelDescription
id uint64

Validated Fields

Field Validations
id
  • uint64.gte: 1

ListUserExampleByIDsReply

FieldTypeLabelDescription
userExamples UserExample repeated

ListUserExampleByIDsRequest

FieldTypeLabelDescription
ids uint64 repeated

ListUserExampleReply

FieldTypeLabelDescription
total int64

userExamples UserExample repeated

ListUserExampleRequest

FieldTypeLabelDescription
params types.Params

Validated Fields

Field Validations
params
  • message.required: true

UpdateUserExampleByIDReply

UpdateUserExampleByIDRequest

FieldTypeLabelDescription
id uint64

name string

name

email string

email

password string

password

phone string

phone number

avatar string

avatar

age int32

age

gender GenderType

gender, 1:Male, 2:Female, other values:unknown

status int32

account status

login_at int64

login timestamp

Validated Fields

Field Validations
id
  • uint64.gte: 1

UserExample

FieldTypeLabelDescription
id uint64

name string

name

email string

email

phone string

phone number

avatar string

avatar

age int32

age

gender GenderType

gender, 1:Male, 2:Female, other values:unknown

status int32

account status

login_at int64

login timestamp

created_at int64

creation time

updated_at int64

update time

GenderType

NameNumberDescription
UNKNOWN 0

MALE 1

FEMALE 2

userExampleService

Method NameRequest TypeResponse TypeDescription
Create CreateUserExampleRequest CreateUserExampleReply

DeleteByID DeleteUserExampleByIDRequest DeleteUserExampleByIDReply

UpdateByID UpdateUserExampleByIDRequest UpdateUserExampleByIDReply

GetByID GetUserExampleByIDRequest GetUserExampleByIDReply

ListByIDs ListUserExampleByIDsRequest ListUserExampleByIDsReply

List ListUserExampleRequest ListUserExampleReply

Methods with HTTP bindings

Method Name Method Pattern Body
Create POST /api/v1/userExample *
DeleteByID DELETE /api/v1/userExample/{id}
UpdateByID PUT /api/v1/userExample/{id} *
GetByID GET /api/v1/userExample/{id}
ListByIDs POST /api/v1/userExample/list/ids *
List POST /api/v1/userExample/list *

api/types/types.proto

Top

Column

FieldTypeLabelDescription
name string

column name

exp string

expressions, which default to = when the value is null, have =, ! =, >, >=, <, <=, like

value string

column value

logic string

logical type, defaults to and when value is null, only &(and), ||(or)

Params

FieldTypeLabelDescription
page int32

page number, starting from 0

limit int32

lines per page

sort string

sorted fields, multi-column sorting separated by commas

columns Column repeated

query conditions

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)