feat: add create snapshot api document (#89)

Author: zsq1234

content/guides/pro/api.ja-JP.mdx

@@ -177,6 +177,50 @@ title: API
   }}
 />
 
+### スナップショットを生成する
+
+<APITable
+  request={{
+    method: 'GET',
+    url: '/universer-api/snapshot/{type}/unit/{unitID}/rev/0/ensure',
+    parametersType: 'Query',
+    parameters: [{
+      name: 'type',
+      type: 'enum(int)',
+      required: true,
+      description: '1（doc）、2（sheet）',
+    }, {
+      name: 'unitID',
+      type: 'string',
+      required: true,
+      description: 'ドキュメント ID',
+    }],
+    example: `curl -X GET 'http://localhost:8000/universer-api/snapshot/2/unit/ETVf-B4lQqOSE_p09mcp9Q/rev/0/ensure'`,
+  }}
+  response={{
+    type: 'application/json',
+    parameters: [{
+      name: 'error',
+      type: 'object',
+      properties: [{
+        name: 'code',
+        type: 'enum(int)',
+        description: '1（成功）',
+      }, {
+        name: 'message',
+        type: 'string',
+        description: 'エラーメッセージ',
+      }],
+    }],
+    example: JSON.stringify({
+      error: {
+        code: 1,
+        message: '',
+      },
+    }, null, 2),
+  }}
+/>
+
 ## ファイルとインポート/エクスポート
 
 ### ファイルアップロード

content/guides/pro/api.mdx

@@ -177,6 +177,50 @@ This page lists common Univer Server APIs. The default base URL is `http://local
   }}
 />
 
+### Create Snapshot
+
+<APITable
+  request={{
+    method: 'GET',
+    url: '/universer-api/snapshot/{type}/unit/{unitID}/rev/0/ensure',
+    parametersType: 'Query',
+    parameters: [{
+      name: 'type',
+      type: 'enum(int)',
+      required: true,
+      description: '1 (doc), 2 (sheet) for path',
+    }, {
+      name: 'unitID',
+      type: 'string',
+      required: true,
+      description: 'Document id',
+    }],
+    example: `curl -X GET 'http://localhost:8000/universer-api/snapshot/2/unit/ETVf-B4lQqOSE_p09mcp9Q/rev/0/ensure'`,
+  }}
+  response={{
+    type: 'application/json',
+    parameters: [{
+      name: 'error',
+      type: 'object',
+      properties: [{
+        name: 'code',
+        type: 'enum(int)',
+        description: '1 (success)',
+      }, {
+        name: 'message',
+        type: 'string',
+        description: 'Error message',
+      }],
+    }],
+    example: JSON.stringify({
+      error: {
+        code: 1,
+        message: '',
+      },
+    }, null, 2),
+  }}
+/>
+
 ## Files and Import/Export
 
 ### Upload File

content/guides/pro/api.zh-CN.mdx

@@ -177,6 +177,50 @@ title: API
   }}
 />
 
+### 生成快照
+
+<APITable
+  request={{
+    method: 'GET',
+    url: '/universer-api/snapshot/{type}/unit/{unitID}/rev/0/ensure',
+    parametersType: 'Query',
+    parameters: [{
+      name: 'type',
+      type: 'enum(int)',
+      required: true,
+      description: '1（doc），2（sheet）路径参数',
+    }, {
+      name: 'unitID',
+      type: 'string',
+      required: true,
+      description: '文档 id',
+    }],
+    example: `curl -X GET 'http://localhost:8000/universer-api/snapshot/2/unit/ETVf-B4lQqOSE_p09mcp9Q/rev/0/ensure'`,
+  }}
+  response={{
+    type: 'application/json',
+    parameters: [{
+      name: 'error',
+      type: 'object',
+      properties: [{
+        name: 'code',
+        type: 'enum(int)',
+        description: '1（成功）',
+      }, {
+        name: 'message',
+        type: 'string',
+        description: '失败信息',
+      }],
+    }],
+    example: JSON.stringify({
+      error: {
+        code: 1,
+        message: '',
+      },
+    }, null, 2),
+  }}
+/>
+
 ## 文件与导入导出
 
 ### 上传文件

content/guides/pro/api.zh-TW.mdx

@@ -177,6 +177,50 @@ title: API
   }}
 />
 
+### 生成快照
+
+<APITable
+  request={{
+    method: 'GET',
+    url: '/universer-api/snapshot/{type}/unit/{unitID}/rev/0/ensure',
+    parametersType: 'Query',
+    parameters: [{
+      name: 'type',
+      type: 'enum(int)',
+      required: true,
+      description: '1（doc），2（sheet）路徑參數',
+    }, {
+      name: 'unitID',
+      type: 'string',
+      required: true,
+      description: '文檔 id',
+    }],
+    example: `curl -X GET 'http://localhost:8000/universer-api/snapshot/2/unit/ETVf-B4lQqOSE_p09mcp9Q/rev/0/ensure'`,
+  }}
+  response={{
+    type: 'application/json',
+    parameters: [{
+      name: 'error',
+      type: 'object',
+      properties: [{
+        name: 'code',
+        type: 'enum(int)',
+        description: '1（成功）',
+      }, {
+        name: 'message',
+        type: 'string',
+        description: '失敗信息',
+      }],
+    }],
+    example: JSON.stringify({
+      error: {
+        code: 1,
+        message: '',
+      },
+    }, null, 2),
+  }}
+/>
+
 ## 檔案與匯入匯出
 
 ### 上傳檔案

examples/univer-vue2/README.md

@@ -2,19 +2,19 @@
 
 ## Project setup
 
-```
+```shell
 pnpm install
 ```
 
 ### Compiles and hot-reloads for development
 
-```
+```shell
 pnpm run serve
 ```
 
 ### Compiles and minifies for production
 
-```
+```shell
 pnpm run build
 ```