课程接口

课程分页列表

接口地址：

  1. /api/v1/courses

请求方法：GET

请求参数：

参数 默认值 说明
page_size 10 每页显示条数
page 1 页码
keywords 空 视频名关键字搜索

返回参数：

成功：

  1. {
  2.     "data": [
  3.         {
  4.             "id": 1,
  5.             "title": "Vivienne Reichel",
  6.             "slug": "ut-beatae-perspiciatis-sit-nisi-explicabo",
  7.             "thumb": "https://lorempixel.com/640/480/?87563",
  8.             "charge": 9,
  9.             "short_description": "<p>Miss</p>",
  10.             "published_at": 1539482458
  11.         }
  12.     ],
  13.     "links": {
  14.         "first": "http://127.0.0.1:8000/api/v1/courses?page=1",
  15.         "last": "http://127.0.0.1:8000/api/v1/courses?page=5",
  16.         "prev": null,
  17.         "next": "http://127.0.0.1:8000/api/v1/courses?page=2"
  18.     },
  19.     "meta": {
  20.         "current_page": 1,
  21.         "from": 1,
  22.         "last_page": 5,
  23.         "path": "http://127.0.0.1:8000/api/v1/courses",
  24.         "per_page": 10,
  25.         "to": 10,
  26.         "total": 50
  27.     }
  28. }

返回字段说明：

字段 说明
data[].id 课程ID
data[].title 课程标题
data[].slug 课程标识符
data[].thumb 课程封面
data[].charge 课程收费
data[].short_description 课程简短介绍
data[].published_at 课程上线时间

课程详情

地址：

  1. /api/v1/course/{id}

请求方法：GET

请求参数：

  1. 无

返回参数：

成功(200)：

  1. {
  2.     "data": {
  3.         "id": 1,
  4.         "title": "Vivienne Reichel",
  5.         "slug": "ut-beatae-perspiciatis-sit-nisi-explicabo",
  6.         "thumb": "https://lorempixel.com/640/480/?87563",
  7.         "charge": 9,
  8.         "short_description": "<p>Miss</p>",
  9.         "description": "<p>Eos et neque qui ut doloribus. Quis at consectetur recusandae sed eius non laborum aut. Et nihil laudantium est. Sint qui quidem labore enim vero autem aut.</p>",
  10.         "published_at": 1539482458
  11.     }
  12. }

返回参数说明：请参考上面的课程分页列表接口。

失败(非200,如：404)：

  1. {
  2.     "message": "No query results for model [App\\Models\\Course].",
  3.     "code" : 500
  4. }

课程下的视频列表

接口：

  1. /api/v1/course/{id}/videos

请求方法：GET

请求参数：

  1. 无

返回参数:

成功(200)：

  1. {
  2.     "data": [
  3.         {
  4.             "id": 1,
  5.             "title": "Crystel Collier",
  6.             "slug": "quia-voluptatibus-eaque-debitis-placeat-iusto-libero-nulla-quibusdam",
  7.             "view_num": 4,
  8.             "charge": 179,
  9.             "short_description": "<p>Prof.</p>",
  10.             "published_at": 389614221
  11.         }
  12.     ]
  13. }

参数说明：

字段 说明
data[].id 视频ID
data[].title 视频名
data[].slug 视频标识符
data[].view_num 视频播放次数
data[].charge 视频收费
data[].short_description 视频简单介绍
data[].published_at 视频上线时间

课程评论

接口：

  1. /api/v1/course/{id}/comments

请求方法：GET

请求参数：

字段 默认值 说明
page_size 10 每页显示条数
page 1 页码

返回参数：

  1. {
  2.     "data": [
  3.         {
  4.             "user": {
  5.                 "avatar": "/images/default_avatar.jpg",
  6.                 "nick_name": "小滕",
  7.                 "mobile": "13675626825",
  8.                 "role": {
  9.                     "role": "年度会员",
  10.                     "expired_at": 1550196621
  11.                 },
  12.                 "unread_notification_num": 0
  13.             },
  14.             "content": "<p>123123 &#x1f604;</p>",
  15.             "created_at": 1539570110
  16.         }
  17.     ],
  18.     "links": {
  19.         "first": "http://127.0.0.1:8000/api/v1/course/1/comments?page=1",
  20.         "last": "http://127.0.0.1:8000/api/v1/course/1/comments?page=1",
  21.         "prev": null,
  22.         "next": null
  23.     },
  24.     "meta": {
  25.         "current_page": 1,
  26.         "from": 1,
  27.         "last_page": 1,
  28.         "path": "http://127.0.0.1:8000/api/v1/course/1/comments",
  29.         "per_page": 10,
  30.         "to": 1,
  31.         "total": 1
  32.     }
  33. }

字段见名知意，这里不做解释了 :smile: ，对我就是懒了 :joy:

课程评论提交

接口(POST)：

  1. /api/v1/course/{id}/comment

请求参数：

字段 默认值 说明
content 评论内容

返回参数：

  1. {
  2.     "data": {
  3.         "user": {
  4.             "avatar": "/images/default_avatar.jpg",
  5.             "nick_name": "小滕",
  6.             "mobile": "13675626825",
  7.             "role": {
  8.                 "role": "年度会员",
  9.                 "expired_at": 1550196621
  10.             },
  11.             "unread_notification_num": 0
  12.         },
  13.         "content": "<p>123123 &#x1f604;</p>",
  14.         "created_at": 1539570110
  15.     }
  16. }

评论成功返回评论相关内容。