Skip to content

Commit

Permalink
Merge pull request #65 from shalousun/master
Browse files Browse the repository at this point in the history 
update: Add a description for the showValidation option.
  • Loading branch information
@shalousun
shalousun authored Mar 7, 2024
2 parents efdb4d3 + f1eecb7 commit c7b376d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
4 changes: 3 additions & 1 deletion docs/advanced/config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,9 @@
| `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. |
| `apiUploadNums` | `3.0.2` | ❌ | `Integer` | | When uploading Torna, batch uploading of documents is supported, and the size of document batches can be set. |
| `showValidation`| `3.0.3` | ❌ | `Boolean` | `true` | `showValidation` is used to control whether `smart-doc` extracts the JSR validation information of fields for display in the documentation. | |

```json
{
"serverUrl": "http://127.0.0.1",
Expand Down
4 changes: 2 additions & 2 deletions docs/zh-cn/advanced/config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@
| `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` 生成代码 |
| `increment` | `3.0.0` | ❌ | `Boolean` | `false` | `increment`用于控制是否让`smart-doc`根据`GIT`代码的变更实现文档的增量推送 |
| ·`apiUploadNums` | `3.0.2` | ❌ | `Integer` | `RANDOM` | 上传torna时，支持文档分批上传，设置文档批次的大小。 |

| `apiUploadNums` | `3.0.2` | ❌ | `Integer` | | 上传torna时，支持文档分批上传，设置文档批次的大小。不配置则一次上传所有 |
| `showValidation` | `3.0.3` | ❌ | `Boolean` | `true` | `showValidation`用于控制`smart-doc`是否提取JSR字段验证信息展示到文档中 |

```json
{
Expand Down

0 comments on commit c7b376d

Please sign in to comment.