入门和使用

Maven

在项目的pom.xml的dependencies中加入以下内容:

  1. <!--java 解析注释工具类-->
  2. <dependency>
  3.     <groupId>com.github.javaparser</groupId>
  4.     <artifactId>javaparser-core</artifactId>
  5.     <version>3.6.16</version>
  6.     <!--test 就不会打包到项目里面去-->
  7.     <scope>test</scope>
  8. </dependency>

使用

注意

  1. # 请勿重复创建项目 xyjUtils.project("项目名", xyjUrl);
  2. # 不会覆盖小幺鸡上面的原有接口,需自己手动删除

demo

实体类(domain)

  1. @Data
  2. public class User{
  3.     /**
  4.     * 姓名
  5.     */
  6.     private String name;
  7.      /**
  8.      * 年龄
  9.      */
  10.     private Integer age;
  11.     /**
  12.     * 性别 1=男 0=女
  13.     */
  14.     private Integer sex;
  15. }

Controller类

  1. /**
  2.  * 描述:
  3.  *
  4.  * @author fei
  5.  * @date 2020-01-10 13:02
  6.  */
  7. @Api("测试") // 每个Controller类头部需要一个@Api注解 
  8. @RestController
  9. @RequestMapping("/app/test")
  10. public class TestController{
  12.     /**
  13.      *  用户列表
  14.      */
  15.     @Api(value = "用户列表", result = User.class) // 每个方法需要一个@Api注解 
  16.     @GetMapping("listUser")
  17.     public AjaxResult listUser(User user) {
  18.         List<User> userList = new ArrayList<>();
  19.         return AjaxResult.success(userList);
  20.     }
  22.     /**
  23.      *  保存用户信息
  24.      */
  25.     @Api("保存用户信息") // 每个方法需要一个@Api注解 
  26.     @PostMapping("saveUser")
  27.     public AjaxResult saveUser(@RequestBody User user) {
  28.         // userService.save(user);
  29.         return AjaxResult.success();
  30.     }
  31. }

初始化

  1. String xyjUrl="http://api.hfrjkf.cn/";
  2. String email = "邮箱账号";
  3. String password = "密码";
  4. XyjUtils xyjUtils = XyjUtils.create(xyjUrl, email, password);
  6. // 如果你不想输入密码,ok,给我一个登录cookie就可以了
  7. // cookie获取 -> 打开浏览器 -> 访问小幺鸡地址 -> 登陆 -> F12 
  8. String cookie="Hm_lvt_55d48e5f0a7678cab2cdf9fab42b742e=1576118336; Hm_lvt_81159ad58fbecc2d27d9d510ca516684=1578999900,1579053684,1579068654,1579139799; JSESSIONID=ABFB0238BFC6FB871BA2A06216C6170D; x-token=766a9ed959564d6fb57869828bb763ae; Hm_lpvt_81159ad58fbecc2d27d9d510ca516684=1579160491";
  9. XyjUtils xyjUtils = XyjUtils.create(xyjUrl, cookie);

生成项目

  1. /** 
  2. * 项目id只用生成一次
  3. * 生成项目,返回项目id,如果项目已经建好了 
  4. * 打开http://api.hfrjkf.cn/dashboard,右键复制项目链接地址
  5. * http://api.hfrjkf.cn/project/GSTuNM7Jn 
  6. * project 后面就是当前项目的projectId 
  7. * **/
  8. String projectId = xyjUtils.project("项目名", xyjUrl);

单个Controller类生成

  1. xyjUtils.doc("com.lawyer.project.system.controller.TestController", projectId);
  2. // saveUser 方法名
  3. xyjUtils.doc(TestController.class,projectId,"saveUser");

某个包下面所有的Controller

  1. xyjUtils.docByPackageName("com.lawyer.project.system.controller", projectId);