update

e622de64 · zhangxiao · 97444d58 · e622de64
Commit e622de64 authored May 06, 2022 by zhangxiao
Hide whitespace changes
Inline Side-by-side

Showing with 158 additions and 45 deletions

README.md README.md +158 -45

No files found.
--- a/README.md
+++ b/README.md
@@ -88,11 +88,10 @@
 ### method: POST
 ### host: http://182.92.75.61
 ### path: /exhibition/detail
-```json
-{
-    "id":1, // 展览id
-}
-```
+### 参数列表 json
+| 参数 | 说明 | 值 |
+| :-----| ----: | ----: |
+| id | 展览id, int | 1,2.. |
 ### response
 ```json
 {
@@ -100,9 +99,10 @@
    "style": "1", // 1为现代，2为古代
    "title": "主标题",
    "subtitle": "副标题",
-    "cover": "http://xxxxx", // 封面图
+    "cover": "https://xxxxx", // 封面图
    "start_time": "2022-05-10T19:51:00+08:00", // 展会开始时间
    "end_time": "2022-05-20T19:51:00+08:00", // 展会结束时间
+    "stay_time":3, // 停留时间
    "likes": 123, // 点赞数
    "flowers": 123, // 送花数
    "applauses": 123, // 鼓掌数
@@ -123,68 +123,181 @@
    ]
 }
 ```
-# 六、前端接口(暂定)
+# 六、前端接口
 * 1、获取总览列表
+## request 
+### method: GET
+### host: http://182.92.75.61
+### path: /exhibitions
+### 参数列表
+| 参数 | 说明 | 值 |
+| :-----| ----: | ----: |
+| type | 展会分类 | 0全部 1戏剧家 2电影电视家 3音乐家 4美术家 5曲艺家 6舞蹈家 7民间艺术家 8摄影家 9书法家 10文艺评论家 11文艺志愿者 12企业（行业）文联 |
+## response
 ```json
 [
    {
-        "type":1,
-        "name":"全部",
-        "exhibitions":[
+        "type":0,
+        "all":[ // 当前类型下全部展会（当前页返回固定数量展会，例如：最多10个）
            {
-                "id":"12345",
-                "title":"主标题",
-                "subtitle":"副标题",
-                "beginTime":1234567,
-                "endTime":1234567,
-                "likes":123,
-                "thumb":"http://xxxxxxx"
+                "id":"1", // 展览id
+                "style": "1", // 1为现代，2为古代
+                "title": "主标题",
+                "subtitle": "副标题",
+                "cover": "http://xxxxx", // 封面图
+                "start_time": "", // 展会开始时间
+                "end_time": "", // 展会结束时间
+                "opening_ceremony_used": false, // 是否使用开幕式
+                "exhibition_hall_used": true, // 是否使用展厅
+                "studio_used": false, // 是否使用演播厅
+                "likes": 123, // 点赞数
+                "flowers": 123, // 送花数
+                "applauses": 123, // 鼓掌数
+            }
+        ],
+        "fine_works":[ // 当前类型下的精品展会（当前页返回固定数量展会，例如：最多10个）
+            {
+                // 结构同all
+            }
+        ],
+        "masters":[ // 当前类型下的名家展会（当前页返回固定数量展会，例如：最多10个）
+            {
+                // 结构同all
            }
        ]
    }
 ]
 ```

-* 2、获取详细列表
+* 2、点击查看更多
+## request 
+### method: GET
+### host: http://182.92.75.61
+### path: /exhibitions/more
+### 参数列表
+| 参数 | 说明 | 值 |
+| :-----| ----: | ----: |
+| type | 展会分类 | 0全部 1戏剧家 2电影电视家 3音乐家 4美术家 5曲艺家 6舞蹈家 7民间艺术家 8摄影家 9书法家 10文艺评论家 11文艺志愿者 12企业（行业）文联 |
+| filter | 展会精选、名家等过滤 | 0全部 1精品 2名家 |
+| state_filter | 展览时效状态过滤 | 0全部 1正在展览 2往期展览 3即将展览 |
+| page | 第几页 | 1,2... |
+| page_size | 每页展会数量 | 1,2... |
+## response
 ```json
-{
-    "type":1,
-    "name":"全部",
-    "exhibitions":[
-        {
-            "id":"12345",
-            "title":"主标题",
-            "subtitle":"副标题",
-            "beginTime":1234567,
-            "endTime":1234567,
-            "likes":123,
-            "thumb":"http://xxxxxxx"
-        }
-    ]
-}
+[
+    {
+        "type":0,
+        "filter":0,
+        "state_filter": 0,
+        "page":1,
+        "page_size":10,
+        "exhibitions":[ // 当前类型下全部展会（当前页返回固定数量展会，例如：最多10个）
+            {
+                "id":"1", // 展览id
+                "style": "1", // 1为现代，2为古代
+                "title": "主标题",
+                "subtitle": "副标题",
+                "cover": "http://xxxxx", // 封面图
+                "start_time": "", // 展会开始时间
+                "end_time": "", // 展会结束时间
+                "opening_ceremony_used": false, // 是否使用开幕式
+                "exhibition_hall_used": true, // 是否使用展厅
+                "studio_used": false, // 是否使用演播厅
+                "likes": 123, // 点赞数
+                "flowers": 123, // 送花数
+                "applauses": 123, // 鼓掌数
+            }
+        ]
+    }
+]
 ```

 * 3、展品详情页
+## request 
+### method: GET
+### host: http://182.92.75.61
+### path: /exhibit/detail
+### 参数列表
+| 参数 | 说明 | 值 |
+| :-----| ----: | ----: |
+| id | 展品id | 1,2.. |
+## response
 ```json
 {
-    "id":"123456",
-    "name":"《Three masks》",
-    "author":{
-        "name":"张三",
-        "introduction":"1995年出生于xxx"
-    },
-    "audio":"http://xxxxxx",
-    "introduction":"1234567",
+    "id":1, // 展品id
+    "name":"《Three masks》", // 展品名称
+    "author_introduction":"1995年出生于xxx", // 作者介绍
+    "audio":"https://xxxxxx", // 展品语音介绍
+    "introduction":"1234567", // 展品文字介绍
    "details":[
        {
-            "media":"http://xxxxxx",
-            "name":"《Three masks》",
-            "size":"120cm x 60cm"
+            "media":"https://xxxxxx",
+            "detail":"《Three masks》" // 简介
        }
    ],
    "likes":123
 }
 ```
+
 * 4、点赞
+## request 
+### method: GET
+### host: http://182.92.75.61
+### path: /exhibit/like
+### 参数列表
+| 参数 | 说明 | 值 |
+| :-----| ----: | ----: |
+| id | 展品id | 1,2.. |
+## response
+```json
+{
+}
+```
+
 * 5、送花
-* 6、购买表单
\ No newline at end of file
+## request 
+### method: GET
+### host: http://182.92.75.61
+### path: /exhibit/send_flower
+### 参数列表
+| 参数 | 说明 | 值 |
+| :-----| ----: | ----: |
+| id | 展品id | 1,2.. |
+## response
+```json
+{
+}
+```
+
+* 6、鼓掌
+## request 
+### method: GET
+### host: http://182.92.75.61
+### path: /exhibit/give_applause
+### 参数列表
+| 参数 | 说明 | 值 |
+| :-----| ----: | ----: |
+| id | 展品id | 1,2.. |
+## response
+```json
+{
+}
+```
+
+* 7、购买表单
+## request 
+### method: POST
+### host: http://182.92.75.61
+### path: /exhibit/offer
+### 参数列表 json
+| 参数 | 说明 | 值 |
+| :-----| ----: | ----: |
+| id | 展品id, int | 1,2.. |
+| username | 用户名, string | 张三 |
+|  phone | 手机号, string | 185xxx |
+| bid | 出价, int | 123 |
+## response
+```json
+{
+}
+```
\ No newline at end of file