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.8 KiB
5.8 KiB
Protocol Documentation
Table of Contents
api/v1/category.proto
Category
文档分类
Field | Type | Label | Description |
---|---|---|---|
id | int32 | 分类ID | |
parent_id | int32 | 父分类ID | |
title | string | 分类标题 | |
doc_count | int32 | 文档数量 | |
sort | int32 | 排序,倒序排序,值越大越靠前 | |
enable | bool | 是否启用 | |
cover | string | 分类封面 | |
created_at | google.protobuf.Timestamp | 创建时间 | |
updated_at | google.protobuf.Timestamp | 更新时间 |
DeleteCategoryRequest
删除分类请求
Field | Type | Label | Description |
---|---|---|---|
id | int64 | repeated |
GetCategoryRequest
获取分类请求
Field | Type | Label | Description |
---|---|---|---|
id | int64 |
ListCategoryReply
分类列表响应
Field | Type | Label | Description |
---|---|---|---|
total | int64 | 总数 | |
category | Category | repeated | 分类列表 |
ListCategoryRequest
分类列表请求
Field | Type | Label | Description |
---|---|---|---|
page | int64 | 页码 | |
size | int64 | 每页数量 | |
parent_id | int64 | repeated | 父分类ID |
wd | string | 搜索关键字 | |
enable | bool | repeated | 是否启用 |
field | string | repeated | 查询字段 |
CategoryAPI
文档分类API服务
Method Name | Request Type | Response Type | Description |
---|---|---|---|
CreateCategory | Category | .google.protobuf.Empty | 创建分类 |
UpdateCategory | Category | .google.protobuf.Empty | 更新分类 |
DeleteCategory | DeleteCategoryRequest | .google.protobuf.Empty | 删除分类 |
GetCategory | GetCategoryRequest | Category | 获取分类 |
ListCategory | ListCategoryRequest | ListCategoryReply | 分类列表 |
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) |