Browse Source

更新readme

feature_gxh
songjc 4 months ago
parent
commit
07da199bae
4 changed files with 27 additions and 18 deletions
  1. +6
    -3
      README.md
  2. +21
    -15
      docs/JCS_pub_API.md
  3. BIN
      docs/figs/architecture.png
  4. BIN
      docs/figs/roadmap.jpg

+ 6
- 3
README.md View File

@@ -9,7 +9,7 @@
## 项目演化路径

<center>
<img src="docs/figs/roadmap.jpg" width=90% /></center>
<img src="docs/figs/roadmap.png" width=100% /></center>


## 特性
@@ -62,8 +62,11 @@
- **基础设施连接模式**:接入公共基础设施后运行(**可提高数据传输效率,降低用户流量费用**)
- **开源公共基础设施**:
- 任何用户可自主部署公共基础设施,或接入现有公共基础设施
- 免费公共基础设施示例:
- xxx
- 免费公共基础设施:
- 请发邮件至`song-jc@foxmail.com`领取账号密码和证书,申请流程如下图。

<center>
<img src="docs/figs/application.png" width=90% /></center>


## 架构图


+ 21
- 15
docs/JCS_pub_API.md View File

@@ -1,6 +1,6 @@
# JCS-pub API

**跳转回README.md [中文](../README.md) [英文](../README_en.md)**
**跳转回README.md [中文](../README.md) [English](../README_en.md)**

## 1 桶相关

@@ -60,7 +60,9 @@
</tr>
<tr>
<td>Query</td>
<td colspan="2">&#45; name:string // 桶名</td>
<td colspan="2">
<p>&#45; name:string // 桶名</p>
</td>
</tr>
<tr>
<td>Body</td>
@@ -221,8 +223,8 @@
<tr>
<td>Query</td>
<td colspan="2">
<p> &#45; bucketName:string // 桶名
&#45; packageName:string // 包名 </p>
<p>&#45; bucketName:string // 桶名
&#45; packageName:string // 包名 </p>
</td>
</tr>
<tr>
@@ -264,7 +266,7 @@
<tr>
<td>Query</td>
<td colspan="2">
<p> &#45; bucketID:int64 // 桶ID </p>
<p>&#45; bucketID:int64 // 桶ID </p>
</td>
</tr>
<tr>
@@ -440,9 +442,9 @@ testdata2
<tr>
<td>Query</td>
<td colspan="2">
<p> &#45; objectID:int64
&#45; offset:int64 // 偏移量
&#45; length:int64 // 读取长度。不存在则读取整个对象 </p>
<p>&#45; objectID:int64
&#45; offset:int64 // 偏移量
&#45; length:int64 // 读取长度。不存在则读取整个对象 </p>
</td>
</tr>
<tr>
@@ -479,9 +481,9 @@ testdata2
<tr>
<td>Query</td>
<td colspan="2">
<p> &#45; path:string
&#45; offset:int64 // 偏移量
&#45; length:int64 // 读取长度。不存在则读取整个对象 </p>
<p>&#45; path:string
&#45; offset:int64 // 偏移量
&#45; length:int64 // 读取长度。不存在则读取整个对象 </p>
</td>
</tr>
<tr>
@@ -518,7 +520,7 @@ testdata2
<tr>
<td>Query</td>
<td colspan="2">
<p> &#45; packageID:int64
<p>&#45; packageID:int64
&#45; path:string
&#45; isPrefix:bool // 如果为true,则会用path参数进行前缀查询
&#45; noRecursive:bool // 如果为true,则在进行前缀查询的时候,会用类似查询目录的方式分别返回对象和“目录”
@@ -591,7 +593,7 @@ testdata2
<tr>
<td>Query</td>
<td colspan="2">
<p> &#45; packageID:int64 </p>
<p>&#45; packageID:int64 </p>
</td>
</tr>
<tr>
@@ -1122,7 +1124,9 @@ testdata2
</tr>
<tr>
<td>Query</td>
<td colspan="2">&#45; userSpaceID: int64</td>
<td colspan="2">
<p>&#45; userSpaceID: int64</p>
</td>
</tr>
<tr>
<td>Body</td>
@@ -1412,7 +1416,9 @@ testdata2
</tr>
<tr>
<td>Query</td>
<td colspan="2">&#45; taskID: int64</td>
<td colspan="2">
<p>&#45; taskID: int64</p>
</td>
</tr>
<tr>
<td>Body</td>


BIN
docs/figs/architecture.png View File

Before After
Width: 760  |  Height: 520  |  Size: 141 kB Width: 491  |  Height: 491  |  Size: 33 kB

BIN
docs/figs/roadmap.jpg View File

Before After
Width: 1331  |  Height: 748  |  Size: 409 kB

Loading…
Cancel
Save