소스 검색

完善controller描述说明

caixin 3 년 전
부모
커밋
fcb1be78f1
1개의 변경된 파일4개의 추가작업 그리고 4개의 파일을 삭제
  1. 4 4
      src/main/resources/generator/controller.ftl

+ 4 - 4
src/main/resources/generator/controller.ftl

@@ -21,18 +21,18 @@ import org.springframework.web.bind.annotation.RestController;
 @Generated(value = "${oldBasePackage}.util.codegenerator.CodeGenerator")
 public class ${table.className}Controller extends AbstractController<${table.className}Dto, ${table.className}Service> {
 
-    @ApiOperation(value = "查询示例接口", notes = "本接口只做展示,方便对照getAll接口的请求参数规则,无实际功能")
+    @ApiOperation(value = "查询示例接口", notes = "本接口只做展示,方便对照getAll接口的请求参数规则,无实际功能,注意search_xxx格式参数的说明")
     @ApiImplicitParams({
     @ApiImplicitParam(name = "offset", value = "分页-偏移页数", required = true, paramType = "form"),
     @ApiImplicitParam(name = "pageNumber", value = "分页-当前页数", required = true, paramType = "form"),
     @ApiImplicitParam(name = "pageSize", value = "分页-没页查询总数", required = true, paramType = "form"),
-    @ApiImplicitParam(name = "sort", value = "分页-排序方式(按字段)", required = false, paramType = "form"),
+    @ApiImplicitParam(name = "sort", value = "分页-排序方式(传入参数为:${table.className}Dto字段名称)", required = false, paramType = "form"),
     @ApiImplicitParam(name = "search_id", value = "实体-主键id", required = false, paramType = "form"),
-    @ApiImplicitParam(name = "search_name", value = "实体-名称", required = false, paramType = "form")
+    @ApiImplicitParam(name = "search_xxx", value = "同理,${table.className}Dto实体的其他字段都可以使用'search_字段名称'的格式传入参数实现对指定字段的条件查询", required = false, paramType = "form")
     })
     @GetMapping("/getAllTemplate")
     public List<${table.className}Dto> getAllTemplate(@RequestParam Integer offset, @RequestParam Integer pageNumber, @RequestParam Integer pageSize, @RequestParam String sort,
-     @RequestParam Integer id, @RequestParam String search_name) {
+     @RequestParam String search_id, @RequestParam String search_xxx) {
        return null;
      }
 }