huayandong

doc api

@@ -11,11 +11,13 @@ @@ -11,11 +11,13 @@
11 - RequestBody: 11 - RequestBody:
12 12
13 ```json 13 ```json
  14 +{
14 // 登录凭证 15 // 登录凭证
15 - private String jsCode; 16 + "jsCode": "wx_jsCode",
16 // 用户信息 17 // 用户信息
17 - private String nickName; 18 + "nickName": "user_nickName",
18 - private String avatarUrl; 19 + "avatarUrl":"user_avatarUrl"
  20 +}
19 ``` 21 ```
20 22
21 - ResponseBody: 23 - ResponseBody:
@@ -28,3 +30,48 @@ @@ -28,3 +30,48 @@
28 private String openId; 30 private String openId;
29 private String wxToken; 31 private String wxToken;
30 ``` 32 ```
  33 +
  34 +##### 2. 通过邀请码,建立邀请关系
  35 +
  36 +- URL: {{localhost}}/boxfish-online-card/wxUser/addRelationship
  37 +- Method: POST
  38 +- RequestBody:
  39 +
  40 +```json
  41 +{
  42 + "openId": "user_openId",
  43 + "invitationCode": "invitation_code"
  44 +}
  45 +```
  46 +
  47 +- ResponseBody:
  48 +
  49 +```java
  50 +public static class Response {
  51 + // status
  52 + private ResponseStatus status;
  53 + private String message;
  54 +
  55 + // 分享人信息
  56 + private String sourceOpenId;
  57 + private String sourceNickName;
  58 + private String sourceAvatarUrl;
  59 + // 领取人信息
  60 + private String targetOpenId;
  61 + private String targetNickName;
  62 + private String targetAvatarUrl;
  63 +
  64 + // 用户当前状态
  65 + private Boolean flagUserHasObtain; // 是否领取课程
  66 + private Long invitationCode; // 已经领取,返回当前用户的邀请码
  67 +}
  68 +```
  69 +
  70 +
  71 +
  72 +
  73 +##### 3. 微信用户获取全部的教材版本、年级信息
  74 +
  75 +- URL: {{localhost}}/boxfish-online-card/textbook/version/getTextbookGrade
  76 +- Method: GET
  77 +- RequestBody: