ContiNew/continew-admin
1
1
Fork 0
mirror of https://github.com/continew-org/continew-admin.git synced 2025-09-11 16:57:12 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: 完善代码生成相关接口文档信息

Browse Source
This commit is contained in:
Charles7c
2023-08-12 23:33:58 +08:00
parent 72399d9226
commit 9def265af6
8 changed files with 48 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
continew-admin-webapi/src/main/java/top/charles7c/cnadmin/webapi/controller/tool/GeneratorController.java
View File

@@ -22,6 +22,9 @@ import java.util.List;
import lombok.RequiredArgsConstructor;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.Parameters;
import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.validation.annotation.Validated;
@@ -62,6 +65,11 @@ public class GeneratorController {
}
@Operation(summary = "查询字段配置列表", description = "查询字段配置列表")
@Parameters({
@Parameter(name = "tableName", description = "表名称", required = true, example = "sys_user",
in = ParameterIn.PATH),
@Parameter(name = "requireSync", description = "是否需要同步", example = "true",
in = ParameterIn.QUERY)})
@GetMapping("/field/{tableName}")
public R<List<FieldConfigDO>> listFieldConfig(@PathVariable String tableName,
@RequestParam(required = false, defaultValue = "false") Boolean requireSync) {
@@ -69,12 +77,14 @@ public class GeneratorController {
}
@Operation(summary = "查询生成配置信息", description = "查询生成配置信息")
@Parameter(name = "tableName", description = "表名称", required = true, example = "sys_user", in = ParameterIn.PATH)
@GetMapping("/config/{tableName}")
public R<GenConfigDO> getGenConfig(@PathVariable String tableName) throws SQLException {
return R.ok(generatorService.getGenConfig(tableName));
}
@Operation(summary = "保存配置信息", description = "保存配置信息")
@Parameter(name = "tableName", description = "表名称", required = true, example = "sys_user", in = ParameterIn.PATH)
@PostMapping("/config/{tableName}")
public R saveConfig(@Validated @RequestBody GenConfigRequest request, @PathVariable String tableName) {
generatorService.saveConfig(request, tableName);
@@ -82,6 +92,7 @@ public class GeneratorController {
}
@Operation(summary = "生成代码", description = "生成代码")
@Parameter(name = "tableName", description = "表名称", required = true, example = "sys_user", in = ParameterIn.PATH)
@PostMapping("/{tableName}")
public R generate(@PathVariable String tableName) {
ValidationUtils.throwIf("prod".equals(SpringUtil.getActiveProfile()), "仅支持在开发环境生成代码");