You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
5.4 KiB
5.4 KiB
Protocol Documentation
Table of Contents
api/v1/favorite.proto
DeleteFavoriteRequest
取消收藏
Field | Type | Label | Description |
---|---|---|---|
id | int64 | repeated |
Favorite
文档收藏
Field | Type | Label | Description |
---|---|---|---|
id | int64 | ||
user_id | int64 | ||
document_id | int64 | ||
title | string | ||
ext | string | ||
score | int32 | ||
size | int64 | ||
pages | int32 | ||
created_at | google.protobuf.Timestamp | ||
updated_at | google.protobuf.Timestamp |
GetFavoriteRequest
根据文章id,查询用户是否有收藏某篇文档
Field | Type | Label | Description |
---|---|---|---|
document_id | int64 |
ListFavoriteReply
查询用户的收藏
Field | Type | Label | Description |
---|---|---|---|
total | int64 | ||
favorite | Favorite | repeated |
ListFavoriteRequest
查询用户的收藏
Field | Type | Label | Description |
---|---|---|---|
page | int64 | ||
size | int64 | ||
user_id | int64 |
FavoriteAPI
Method Name | Request Type | Response Type | Description |
---|---|---|---|
CreateFavorite | Favorite | Favorite | 添加收藏 |
DeleteFavorite | DeleteFavoriteRequest | .google.protobuf.Empty | 取消收藏 |
GetFavorite | GetFavoriteRequest | Favorite | 根据文章id,查询用户是否有收藏某篇文档 |
ListFavorite | ListFavoriteRequest | ListFavoriteReply | 查询用户的收藏 |
Scalar Value Types
.proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
---|---|---|---|---|---|---|---|---|
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) |