新潮教室二期文档

liqingzhong
Commit 6448251c4f58b3f6cb58cca4298f6b056ded1387 1 parent d46ac116
Showing 1 changed file with 324 additions and 85 deletions
StarClass/README.md
--- a/StarClass/README.md
View file @6448251
+++ b/StarClass/README.md
View file @6448251
+
 新潮教室签到
 ------------
@@ -7,10 +8,10 @@
 #### 入参
-| 参数名称 | 参数类型 |  可否为空 | 示例 | 默认值 | 备注 | 
-|:---------|---------:|----------:|-----:|-------:|-----:| 
-| method   | string   | 否        | app.starClass.rankInfo |||
-| uid      | int      | 否        | 213  | 0      |用户id|
+| 参数名称   |   参数类型 | 可否为空 |                     示例 |  默认值 |   备注 |
+| :----- | -----: | ---: | ---------------------: | ---: | ---: |
+| method | string |    否 | app.starClass.rankInfo |      |      |
+| uid    |    int |    否 |                    213 |    0 | 用户id |
 #### 出参
@@ -31,11 +32,11 @@
 ### 错误码
-| 错误码 code | message | 说明 |
-|-------------|---------|------|
-| 200         | success |      |
-| 400         | 输入参数错误 | 没传 uid  |
-| 500         | 获取个人排名失败 | uid 不存在或者查询 redis 失败  |
+| 错误码 code | message  | 说明                   |
+| -------- | -------- | -------------------- |
+| 200      | success  |                      |
+| 400      | 输入参数错误   | 没传 uid               |
+| 500      | 获取个人排名失败 | uid 不存在或者查询 redis 失败 |
 ## 2.签到
@@ -43,10 +44,10 @@
 #### 入参
-| 参数名称 | 参数类型 |  可否为空 | 示例 | 默认值 | 备注 | 
-|:---------|---------:|----------:|-----:|-------:|-----:| 
-| method   | string   | 否        | app.starClass.sign |||
-| uid      | int      | 否        | 213  | 0      |用户id|
+| 参数名称   |   参数类型 | 可否为空 |                 示例 |  默认值 |   备注 |
+| :----- | -----: | ---: | -----------------: | ---: | ---: |
+| method | string |    否 | app.starClass.sign |      |      |
+| uid    |    int |    否 |                213 |    0 | 用户id |
 #### 出参
@@ -96,11 +97,11 @@
 ### 错误码
-| 错误码 code | message | 说明 |
-|-------------|---------|------|
-| 200         | success |      |
-| 400         | 输入参数错误 | 没传 uid  |
-| 500         | 设置 redis 失败 | 比如 redis 挂了等情况 |
+| 错误码 code | message     | 说明             |
+| -------- | ----------- | -------------- |
+| 200      | success     |                |
+| 400      | 输入参数错误      | 没传 uid         |
+| 500      | 设置 redis 失败 | 比如 redis 挂了等情况 |
 ## 3.转发
@@ -108,10 +109,10 @@
 #### 入参
-| 参数名称 | 参数类型 |  可否为空 | 示例 | 默认值 | 备注 | 
-|:---------|---------:|----------:|-----:|-------:|-----:| 
-| method   | string   | 否        | app.starClass.forward |||
-| uid      | int      | 否        | 213  | 0      |用户id|
+| 参数名称   |   参数类型 | 可否为空 |                    示例 |  默认值 |   备注 |
+| :----- | -----: | ---: | --------------------: | ---: | ---: |
+| method | string |    否 | app.starClass.forward |      |      |
+| uid    |    int |    否 |                   213 |    0 | 用户id |
 #### 出参
@@ -127,20 +128,20 @@
 ### 错误码
-| 错误码 code | message | 说明 |
-|-------------|---------|------|
-| 200         | success |      |
-| 400         | 输入参数错误 | 没传 uid  |
-| 500         | 设置 redis 失败 | 比如 redis 挂了等情况 |
+| 错误码 code | message     | 说明             |
+| -------- | ----------- | -------------- |
+| 200      | success     |                |
+| 400      | 输入参数错误      | 没传 uid         |
+| 500      | 设置 redis 失败 | 比如 redis 挂了等情况 |
 ## 前 100
 `method=app.starClass.top100`
-| 参数名称 | 参数类型 |  可否为空 | 示例 | 默认值 | 备注 | 
-|:---------|---------:|----------:|-----:|-------:|-----:| 
-| method   | string   | 否        | app.starClass.top100 |||
-| uid      | int      | 是        | 213  | 0      |用户id|
+| 参数名称   |   参数类型 | 可否为空 |                   示例 |  默认值 |   备注 |
+| :----- | -----: | ---: | -------------------: | ---: | ---: |
+| method | string |    否 | app.starClass.top100 |      |      |
+| uid    |    int |    是 |                  213 |    0 | 用户id |
 #### 出参
@@ -194,26 +195,26 @@
 ### 错误码
-| 错误码 code | message | 说明 |
-|-------------|---------|------|
-| 200         | success |      |
-| 500         | 查询 redis 失败 | 比如 redis 挂了等情况 |
+| 错误码 code | message     | 说明             |
+| -------- | ----------- | -------------- |
+| 200      | success     |                |
+| 500      | 查询 redis 失败 | 比如 redis 挂了等情况 |
 ## 4.获得星潮教室中星搭配的文章
 星搭配文章取逛后台新增的标签分类‘星潮教室’，标签开启状态下的文章（/guang/api/*/article/getStarClassroomArticleList）（app接口）
-| 接口说明 |  接口说明 | 
-|:------- | -----:|
-|请求域名 | http://api.yoho.cn/ |
-|接口名 | /guang/api/*/article/getStarClassroomArticleList |
-|接口说明 | 获得星潮教室中星搭配的文章 |
-|接口说明 | get |
+| 接口说明 |                                     接口说明 |
+| :--- | ---------------------------------------: |
+| 请求域名 |                      http://api.yoho.cn/ |
+| 接口名  | /guang/api/*/article/getStarClassroomArticleList |
+| 接口说明 |                            获得星潮教室中星搭配的文章 |
+| 接口说明 |                                      get |
 #### 请求参数
-| 参数名称 | 参数类型 | 长度 |  是否必须 | 示例值 | 默认值 | 描述 | 
-|:---------| --------:|-----:| ---------:| ------:| ------:| ----:| 
-|page|Integer|3|否|1|1|页码|
+| 参数名称 |    参数类型 |   长度 | 是否必须 |  示例值 |  默认值 |   描述 |
+| :--- | ------: | ---: | ---: | ---: | ---: | ---: |
+| page | Integer |    3 |    否 |    1 |    1 |   页码 |
 #### 正常返回结果
@@ -293,47 +294,285 @@
 }
 ```
 #### 响应内容描述
-| Param Name | Param Type | Desc | 
-|:---------| --------:|-----:| 
-|alg |String | |
-|code |int |状态码 |
-|md5 |String | |
-|message |String |返回结果内容描述 |
-|data |json |返回数据内容 |
-|datetime |String |当前时间 |
-|page |int |当前页 |
-|total |int |总记录数 |
-|totalPage |int |总页数 |
-|list |json |文章集合对象 |
-|artList |array |文章数组 |
-|ads_img_size |String |广告图片尺寸 |
-|article_type |String |文章类型 |
-|author_id |String |作者ID |
-|author |json |作者对象json |
-|author_id |String |作者ID |
-|avatar |String |产品的图片URL |
-|name |String |名称 |
-|url |String |链接的地址 |
-|category_id |String |分类ID |
-|category_name |String |分类名称 |
-|conver_image_type |String |图片类型 1方图,2长图 |
-|id |String | |
-|intro |String |文章信息 |
-|isFavor |String |是否收藏 |
-|isPraise |String |是否点赞 |
-|is_recommended |String |是否推荐 |
-|praiseStatus |String |点赞状态 |
-|praise_num |String |点赞数量 |
-|publish_time |String |发布时间 |
-|share |json |分享链接 |
-|url |String |分享链接地址 |
-|src |String |图片绝对路径 |
-|title |String |文章标题 |
-|url |String |URL |
-|views_num |String |查看数量 |
+| Param Name        | Param Type |         Desc |
+| :---------------- | ---------: | -----------: |
+| alg               |     String |              |
+| code              |        int |          状态码 |
+| md5               |     String |              |
+| message           |     String |     返回结果内容描述 |
+| data              |       json |       返回数据内容 |
+| datetime          |     String |         当前时间 |
+| page              |        int |          当前页 |
+| total             |        int |         总记录数 |
+| totalPage         |        int |          总页数 |
+| list              |       json |       文章集合对象 |
+| artList           |      array |         文章数组 |
+| ads_img_size      |     String |       广告图片尺寸 |
+| article_type      |     String |         文章类型 |
+| author_id         |     String |         作者ID |
+| author            |       json |     作者对象json |
+| author_id         |     String |         作者ID |
+| avatar            |     String |     产品的图片URL |
+| name              |     String |           名称 |
+| url               |     String |        链接的地址 |
+| category_id       |     String |         分类ID |
+| category_name     |     String |         分类名称 |
+| conver_image_type |     String | 图片类型 1方图,2长图 |
+| id                |     String |              |
+| intro             |     String |         文章信息 |
+| isFavor           |     String |         是否收藏 |
+| isPraise          |     String |         是否点赞 |
+| is_recommended    |     String |         是否推荐 |
+| praiseStatus      |     String |         点赞状态 |
+| praise_num        |     String |         点赞数量 |
+| publish_time      |     String |         发布时间 |
+| share             |       json |         分享链接 |
+| url               |     String |       分享链接地址 |
+| src               |     String |       图片绝对路径 |
+| title             |     String |         文章标题 |
+| url               |     String |          URL |
+| views_num         |     String |         查看数量 |
 #### 异常返回结果：
-| 错误码code | 错误message | 说明 | 
-|:---------| --------:|-----:| 
-| 500| | 内部错误|
+| 错误码code | 错误message |   说明 |
+| :------ | --------: | ---: |
+| 500     |           | 内部错误 |
+
+
+## 5. 新潮教室新首页
+
+#### 请求示例
+
+>http://localhost:8080/gateway?method=app.starClass.index&client_type=h5&code=8adc27fcf5676f356602889afcfd2a8e&debug=XYZ
+
+| 参数名称        |   参数类型 | 可否为空 |                               示例 |                              默认值 |    备注 |
+| :---------- | -----: | ---: | -------------------------------: | -------------------------------: | ----: |
+| method      | string |    否 |              app.starClass.index |                                  |       |
+| client_type | string |    否 |                               h5 |                                  | 客户端类型 |
+| code        | string |    是 | 8adc27fcf5676f356602889afcfd2a8e | 8adc27fcf5676f356602889afcfd2a8e |  资源位码 |
+
+
+#### 出参
+
+```json
+{
+  "alg": "SALT_MD5",
+  "code": 200,
+  "data": {
+    // 焦点图资源位码
+    "ads": {
+      "data": [
+        {
+          "bgColor": "",
+          "src": "http://img10.static.yhbimg.com/yhb-img01/2016/05/26/10/01a2e1f0e92598128e07721cdcdf9f388e.jpg?imageView2/{mode}/w/{width}/h/{height}",
+          "title": "",
+          "url": "123"
+        },
+        {
+          "bgColor": "",
+          "src": "http://img10.static.yhbimg.com/yhb-img01/2016/05/26/10/015b86553a6535a1913c407f95a3d24b96.jpg?imageView2/{mode}/w/{width}/h/{height}",
+          "title": "",
+          "url": "http://www.baidu.com"
+        }
+      ],
+      "focus_type": "1",
+      "template_id": "10036",
+      "template_intro": "焦点图",
+      "template_name": "focus"
+    },
+    // 文章列表
+    "list": [
+      {
+        "article_type": "1",
+        "author_id": "3997053",
+        "category_id": "3",
+        "conver_image_type": "1",
+        "ext": {
+          "tags": [
+            {
+              "classifyId": 2,
+              "cover": "",
+              "createTime": 1432118996,
+              "id": 55,
+              "isHot": 1,
+              "status": 1,
+              "tagName": "吴亦凡"
+            },
+            {
+              "classifyId": 2,
+              "cover": "",
+              "createTime": 1432118997,
+              "id": 57,
+              "isHot": 0,
+              "status": 1,
+              "tagName": "王俊凯"
+            }
+          ]
+        },
+        "id": 34258,
+        // 文章简介
+        "intro": "test",
+        "isFavor": "N",
+        "isPraise": "N",
+        "is_recommended": "1",
+        "praiseStatus": "true",
+        "praise_num": "2",
+        "publish_time": "1464854218",
+        // 文章封面名称
+        "src": "http://img12.static.yhbimg.com/article/2016/06/02/15/02661b0a7967d097c10640aa18029cb57c.png?imageView/{mode}/w/{width}/h/{height}",
+        "tag": "复古,森女,吴亦凡,王俊凯",
+        // 文章标题
+        "title": "SYJ-test",
+        "url": "https://guang.m.yohobuy.com/info/index?id=34258",
+        "views_num": "116"
+      }
+    ],
+    // 标签列表
+    "tags": [
+      {
+        "classifyId": 2,
+        "cover": "", // 标签封面
+        "createTime": 1432118996,
+        "id": 55,
+        "isHot": 1,
+        "status": 1,
+        "tagName": "吴亦凡" // 标签名称
+      },
+      {
+        "classifyId": 2,
+        "cover": "",
+        "createTime": 1432118997,
+        "id": 57,
+        "isHot": 0,
+        "status": 1,
+        "tagName": "王俊凯"
+      }
+    ]
+  },
+  "md5": "ed8e1e65e98b9d5e614e407951108486",
+  "message": "success"
+}
+```
+## 6. 新潮教室明星专区
+
+#### 请求示例
+
+>http://localhost:8080/gateway?method=app.starClass.lastTagArticle&client_type=h5&page=2&tag=吴亦凡&debug=XYZ
+
+#### 入参
+
+| 参数名称        |   参数类型 | 可否为空 |                           示例 |  默认值 |    备注 |
+| :---------- | -----: | ---: | ---------------------------: | ---: | ----: |
+| method      | string |    否 | app.starClass.lastTagArticle |      |       |
+| client_type | string |    否 |                           h5 |      | 客户端类型 |
+| tag         | string |    否 |                          吴亦凡 |      |  明星标签 |
+| page        |    int |    是 |                            1 |    1 |    页码 |
+| size        |    int |    是 |                           10 |   10 |  每页大小 |
+
+
+#### 出参
+
+```json
+{
+  "alg": "SALT_MD5",
+  "code": 200,
+  "data": {
+    "list": [
+      {
+        "article_type": "1",
+        "author_id": "3997053",
+        "category_id": "3",
+        "conver_image_type": "1",
+        // 收藏数量
+        "favor_num": "1",
+        "id": 34258,
+        // 简介
+        "intro": "test",
+        // 是否收藏
+        "isFavor": "N",
+        "isPraise": "N",
+        "is_recommended": "1",
+        "praiseStatus": "true",
+        "praise_num": "2",
+        // 发表时间
+        "publish_time": "1464854218",
+        // 分享
+        "share": {
+          "url": "https://guang.m.yohobuy.com/info/index?id=34258"
+        },
+        // 封面
+        "src": "http://img12.static.yhbimg.com/article/2016/06/02/15/02661b0a7967d097c10640aa18029cb57c.png?imageView/{mode}/w/{width}/h/{height}",
+        "tag": "复古,森女,吴亦凡,王俊凯",
+        // 标题
+        "title": "SYJ-test",
+        // 链接
+        "url": "https://guang.m.yohobuy.com/info/index?id=34258",
+        // 查看次数
+        "views_num": "116"
+      },
+      {
+        "ads_img_size": "1088680",
+        "article_type": "1",
+        "author_id": "589238",
+        "category_id": "19",
+        "conver_image_type": "2",
+        "favor_num": "5",
+        "id": 34230,
+        "intro": "yun_文章，带有预发布时间测试，文章摘要文章摘要文章摘要文章摘要文章摘要文章摘要。",
+        "isFavor": "N",
+        "isPraise": "N",
+        "is_recommended": "1",
+        "praiseStatus": "true",
+        "praise_num": "3",
+        "publish_time": "1464256800",
+        "share": {
+          "url": "https://guang.m.yohobuy.com/info/index?id=34230"
+        },
+        "src": "http://img11.static.yhbimg.com/article/2016/05/17/13/010e112d050341b1927465ce6592265218.png?imageView/{mode}/w/{width}/h/{height}",
+        "tag": "吴亦凡",
+        "title": "yun_文章，带有预发布时间测试",
+        "url": "https://m.yohobuy.com/brands",
+        "views_num": "6"
+      },
+      {
+        "ads_img_size": "1088680",
+        "article_type": "1",
+        "author_id": "521285",
+        "category_id": "2",
+        "conver_image_type": "1",
+        "favor_num": "23",
+        "id": 3,
+        "intro": "依稀记得上初中那会，谁要有一件胸口带“钩子”的衣服，那他/她走路一定昂首挺胸，生怕别人看不见一样！",
+        "isFavor": "N",
+        "isPraise": "N",
+        "is_recommended": "0",
+        "praiseStatus": "true",
+        "praise_num": "28",
+        "publish_time": "1459267200",
+        "share": {
+          "url": "https://guang.m.yohobuy.com/info/index?id=3"
+        },
+        "src": "http://img10.static.yhbimg.com/yhb-img01/2015/05/20/20/017f40fe5be35c9e1412cd8e2164c87e83.jpg?imageView/{mode}/w/{width}/h/{height}",
+        "tag": "吴亦凡,王俊凯",
+        "title": "会动的的免费广告！",
+        "url": "asdasdas",
+        "views_num": "39859"
+      }
+    ],
+    "pageNo": 1,
+    "pageSize": 10,
+    "totalCount": 3,
+    "totalPage": 1
+  },
+  "md5": "824db9354f3da88c6c00a864915eb7cd",
+  "message": "success"
+}
+```
+
+## 其他相关文档
+
+[资讯收藏](http://git.yoho.cn/yoho-documents/api-interfaces/tree/master/%E9%80%9B#10%E8%B5%84%E8%AE%AF%E6%94%B6%E8%97%8F)
+[资讯取消收藏](http://git.yoho.cn/yoho-documents/api-interfaces/tree/master/%E9%80%9B#11%E8%B5%84%E8%AE%AF%E5%8F%96%E6%B6%88%E6%94%B6%E8%97%8F)
+
+