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.
6.0 KiB
6.0 KiB
Protocol Documentation
Table of Contents
api/v1/article.proto
Article
文章
Field | Type | Label | Description |
---|---|---|---|
id | int64 | 文章ID | |
identifier | string | 文章唯一标识 | |
author | string | 文章作者。如果为空,则使用网站名称作为作者 | |
view_count | int64 | 文章浏览次数 | |
title | string | 文章标题 | |
keywords | string | 文章关键字 | |
description | string | 文章描述 | |
content | string | 文章内容 | |
created_at | google.protobuf.Timestamp | 文章创建时间 | |
updated_at | google.protobuf.Timestamp | 文章更新时间 |
DeleteArticleRequest
删除文章请求,传入单个或者多个文章ID
Field | Type | Label | Description |
---|---|---|---|
id | int64 | repeated |
GetArticleRequest
根据ID或者文章标识获取文章,二选一
Field | Type | Label | Description |
---|---|---|---|
id | int64 | 文章ID | |
identifier | string | 文章唯一标识 |
ListArticleReply
文章列表响应
Field | Type | Label | Description |
---|---|---|---|
total | int64 | 文章总数 | |
article | Article | repeated | 文章列表 |
ListArticleRequest
文章列表请求
Field | Type | Label | Description |
---|---|---|---|
page | int64 | 页码 | |
size | int64 | 每页数量 | |
wd | string | 搜索关键字 | |
field | string | repeated | 查询字段 |
order | string | 排序字段,根据指定的字段倒序排序 |
ArticleAPI
文章API服务
Method Name | Request Type | Response Type | Description |
---|---|---|---|
CreateArticle | Article | .google.protobuf.Empty | 创建文章 |
UpdateArticle | Article | .google.protobuf.Empty | 更新文章 |
DeleteArticle | DeleteArticleRequest | .google.protobuf.Empty | 删除文章 |
GetArticle | GetArticleRequest | Article | 获取文章 |
ListArticle | ListArticleRequest | ListArticleReply | 文章列表 |
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) |