Merge pull request #55 from bugDesigner1/master

feat-更新文档（新增‘apiUploadNums’配置）
smart-doc-group · Dec 28, 2023 · cf8087c · cf8087c
2 parents 011d0da + 1c31c06
commit cf8087c
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 4 deletions.
diff --git a/docs/advanced/config.md b/docs/advanced/config.md
@@ -59,7 +59,7 @@
 | `framework` | `2.2.5` | ❌ | `String` | `spring` or `dubbo` | `Spring` and `Apache Dubbo` are frameworks that support parsing and generating documents by `smart-doc` by default and are not configured` framework` automatically selects `Spring` or `Dubbo` according to the triggered document construction scenario. `smart-doc` currently also supports the `JAX-RS` standard, so use a framework that supports the `JAX-RS` standard (such as: ` Quarkus`) can be used as an experience, but it is not complete yet. <br />Optional values: `spring`, `dubbo`, `JAX-RS`, `solon` |
 | `randomMock` | `2.6.9` | ❌ | `Boolean` | `false` | `randomMock` is used to control whether `smart-doc` generates random `mock` values, in versions before `2.6.9` `smart-doc` will automatically assign parameters and automatically generate random values. The generated values are different each time. Now you can set it to `false` to control the generation of random values. |
 | `componentType` | `2.7.8` | ❌ | `String` | `RANDOM` | `openapi component key generator`<br />`RANDOM`: supports `@Validated` group verification<br />`NORMAL` : Does not support `@Validated`, used for `openapi` generated code |
-
+| `apiUploadNums` | `3.0.2` | ❌ | `Integer` | `RANDOM` | When uploading Torna, batch uploading of documents is supported, and the size of document batches can be set. |
 ```json
 {
     "serverUrl": "http://127.0.0.1",
@@ -233,7 +233,8 @@
     ],
     "requestParamsTable": true,
     "responseParamsTable": true,
-    "componentType": 1
+    "componentType": 1,
+    "apiUploadNums": 1
 }
 ```
 

diff --git a/docs/diy/config.md b/docs/diy/config.md
@@ -143,7 +143,8 @@ Example of a complete configuration file
   ],
   "requestParamsTable": true, // Whether to display the request parameter table in the document, the default is true, @since 2.2.5
   "responseParamsTable": true, // Whether to display the response parameter table in the document, the default is true, @since 2.2.5
-  "componentType": 1 // openapi component key generator 1:  support @Validated 2: don't support @Validated, for openapi generator
+  "componentType": 1, // openapi component key generator 1:  support @Validated 2: don't support @Validated, for openapi generator
+  "apiUploadNums": 1
 }
 ```
 
@@ -884,3 +885,15 @@ openapi component key generator RANDOM :  support @Validated NORMAL: don't suppo
     "componentType": "RANDOM"
 }
 ```
+
+## apiUploadNums
+* required: `false`
+* type:`Integer`
+* default: `RANDOM`
+* @since `3.0.2` :new:
+
+When uploading Torna, batch uploading of documents is supported, and the size of document batches can be set. ```json
+{
+    "apiUploadNums": 1
+}
+```
diff --git a/docs/zh-cn/advanced/config.md b/docs/zh-cn/advanced/config.md
@@ -59,7 +59,7 @@
 | `framework` | `2.2.5` | ❌ | `String` | `spring` or `dubbo` | `Spring`和`Apache Dubbo`是`smart-doc`默认支持解析生成文档的框架，不配置`framework`时根据触发的文档构建场景自动选择`Spring`或者 `Dubbo`，`smart-doc`目前也支持`JAX-RS`的标准，因此使用支持`JAX-RS`标准的框架(如：`Quarkus`)可以作为体验使用，但是还不完善。<br />可选值: `spring`,`dubbo`,`JAX-RS`,`solon` |
 | `randomMock` | `2.6.9` | ❌ | `Boolean` | `false` | `randomMock`用于控制是否让`smart-doc`生成随机`mock`值，在`2.6.9`之前的版本中`smart-doc`会自动给参数和自动生成随机值， 每次生成的值都不一样，现在你可以设置为`false`来控制随机值的生成。 |
 | `componentType` | `2.7.8` | ❌ | `String` | `RANDOM` | `openapi component key generator`<br />`RANDOM` : 支持 `@Validated` 分组校验 <br />`NORMAL`: 不支持 `@Validated`, 用于 `openapi` 生成代码 |
-
+| `apiUploadNums` | `3.0.2` | ❌ | `Integer` | `RANDOM` | 上传torna时，支持文档分批上传，设置文档批次的大小。 |
 
 
 ```json