Skip to content

Commit 260dd63

Browse files
sam9831sam9831
committed
更新API示例
1 parent 7c11645 commit 260dd63

File tree

2 files changed

+23
-22
lines changed

2 files changed

+23
-22
lines changed

‎docs/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ features:
99
details: 课程为你提供一个完整闭环的项目，项目包含真实的数据、API以及开发流程，项目完全符合商业项目标准
1010
- title: 多端适配
1111
details: 借助mpvue强大的编译引擎，将vue源码快速转换为多端小程序版本，课程将详细介绍如何实现多端适配
12-
- title: 完整流程
13-
details: 面向初学者，课程难度逐步加深，讲解从账号注册、工具下载、项目开发、API联调到上线发布的完整流程
12+
- title: 开发体验
13+
details: 课程面向初学者，提供完整的文档支持，如开发文档、部署文档、API文档等，同时提供在线API，无需部署，直接调用
1414
footer: © 慕课网（imooc.com）版权所有 | 苏ICP备18055397号-1 | 2019 Powered by Sam
1515
---
1616

‎docs/api/README.md‎

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ API文档中示例部分的域名仅仅作为演示，所以并不能实际生
3636
| shelfCount | int | 书架图书数量 |
3737

3838
#### 示例
39-
- 请求：`https://www.imooc.com/book/home/v2?openId=1234`
39+
- 请求：[https://test.youbaobao.xyz:18081/book/home/v2?openId=1234](https://test.youbaobao.xyz:18081/book/home/v2?openId=1234)
4040
- 响应：
4141
```json
4242
{
@@ -127,6 +127,7 @@ API文档中示例部分的域名仅仅作为演示，所以并不能实际生
127127
| ------------- |:-------------:| -----:| ----:|
128128
| appId | 是 | String | 微信小程序的appId |
129129
| code | 是 | String |微信登录wx.login后获得的code |
130+
| secret | 是 | String |小程序的secret key |
130131

131132
#### 返回值
132133
| 参数名称 | 类型 | 说明 |
@@ -138,7 +139,7 @@ API文档中示例部分的域名仅仅作为演示，所以并不能实际生
138139
| session_key | String | 用户登录sessionKey，用于微信jsapi请求 |
139140

140141
#### 示例
141-
- 请求：`https://www.imooc.com/openId/get?appId=1234&code=5678`
142+
- 请求：[https://test.youbaobao.xyz:18081/openId/get?appId=1234&code=5678&secret=9012](https://test.youbaobao.xyz:18081/openId/get?appId=1234&code=5678&secret=9012)
142143
- 响应：
143144
```json
144145
{
@@ -172,7 +173,7 @@ API文档中示例部分的域名仅仅作为演示，所以并不能实际生
172173
| session_key | String | 用户登录sessionKey，用于支付宝jsapi请求 |
173174

174175
#### 示例
175-
- 请求：`https://www.imooc.com/openId/get/alipay?appId=1234&code=5678`
176+
- 请求：`https://test.youbaobao.xyz:18081/openId/get/alipay?appId=1234&code=5678`
176177
- 响应：
177178
```json
178179
{
@@ -213,7 +214,7 @@ API文档中示例部分的域名仅仅作为演示，所以并不能实际生
213214
| msg | String | 返回消息 |
214215

215216
#### 示例
216-
- 请求：`https://www.imooc.com/user/register`
217+
- 请求：[https://test.youbaobao.xyz:18081/user/register](https://test.youbaobao.xyz:18081/user/register)
217218
- 响应：
218219
```json
219220
{"error_code":0,"msg":"用户注册成功"}
@@ -235,7 +236,7 @@ API文档中示例部分的域名仅仅作为演示，所以并不能实际生
235236
| data | Array | 返回数据 |
236237

237238
#### 示例
238-
- 请求：`https://www.imooc.com/book/home/recommend/v2`
239+
- 请求：[https://test.youbaobao.xyz:18081/book/home/recommend/v2](https://test.youbaobao.xyz:18081/book/home/recommend/v2)
239240
- 响应：
240241
```json
241242
{
@@ -297,7 +298,7 @@ API文档中示例部分的域名仅仅作为演示，所以并不能实际生
297298
| data | Array | 返回数据 |
298299

299300
#### 示例
300-
- 请求：`https://www.imooc.com/book/home/freeRead/v2`
301+
- 请求：[https://test.youbaobao.xyz:18081/book/home/freeRead/v2](https://test.youbaobao.xyz:18081/book/home/freeRead/v2)
301302
- 响应：
302303
```json
303304
{
@@ -371,7 +372,7 @@ API文档中示例部分的域名仅仅作为演示，所以并不能实际生
371372
| data | Array | 返回数据 |
372373

373374
#### 示例
374-
- 请求：`https://www.imooc.com/book/home/hotBook/v2`
375+
- 请求：[https://test.youbaobao.xyz:18081/book/home/hotBook/v2](https://test.youbaobao.xyz:18081/book/home/hotBook/v2)
375376
- 响应：
376377
```json
377378
{
@@ -434,7 +435,7 @@ API文档中示例部分的域名仅仅作为演示，所以并不能实际生
434435
### 获取热门搜索词
435436

436437
#### 接口地址
437-
`GET /book/hot-search/v2`
438+
`GET /book/hot-search`
438439

439440
#### 请求参数
440441
无
@@ -447,7 +448,7 @@ API文档中示例部分的域名仅仅作为演示，所以并不能实际生
447448
| data | Array | 返回数据 |
448449

449450
#### 示例
450-
- 请求：`https://www.imooc.com/book/hot-search/v2`
451+
- 请求：[https://test.youbaobao.xyz:18081/book/hot-search](https://test.youbaobao.xyz:18081/book/hot-search)
451452
- 响应：
452453
```json
453454
{
@@ -512,7 +513,7 @@ API文档中示例部分的域名仅仅作为演示，所以并不能实际生
512513
| book | Array | 匹配到的图书 |
513514

514515
#### 示例
515-
- 请求：`https://www.imooc.com/book/search?keyword=C&page=1&openId=abcd&pageSize=20`
516+
- 请求：[https://test.youbaobao.xyz:18081/book/search?keyword=C&page=1&openId=abcd&pageSize=20](https://test.youbaobao.xyz:18081/book/search?keyword=C&page=1&openId=abcd&pageSize=20)
516517
- 响应：
517518
```json
518519
{
@@ -586,7 +587,7 @@ publisher、author、category、categoryId四个参数至少需要传入一个
586587
| data | Array | 返回数据 |
587588

588589
#### 示例
589-
- 请求：`https://www.imooc.com/book/search-list?category=ComputerScience&page=1&pageSize=20`
590+
- 请求：[https://test.youbaobao.xyz:18081/book/search-list?category=ComputerScience&page=1&pageSize=20](https://test.youbaobao.xyz:18081/book/search-list?category=ComputerScience&page=1&pageSize=20)
590591
- 响应：
591592
```json
592593
{
@@ -638,7 +639,7 @@ publisher、author、category、categoryId四个参数至少需要传入一个
638639
| data | Array | 返回数据 |
639640

640641
#### 示例
641-
- 请求：`https://www.imooc.com/book/category/list/v2`
642+
- 请求：[https://test.youbaobao.xyz:18081/book/category/list/v2](https://test.youbaobao.xyz:18081/book/category/list/v2)
642643
- 响应：
643644
```json
644645
{
@@ -695,7 +696,7 @@ publisher、author、category、categoryId四个参数至少需要传入一个
695696
| rankAvg | String | 平均评分 |
696697

697698
#### 示例
698-
- 请求：`https://www.imooc.com/book/detail?fileName=2015_Book_ContemporaryBioethics&openId=abcd`
699+
- 请求：[https://test.youbaobao.xyz:18081/book/detail?fileName=2015_Book_ContemporaryBioethics&openId=abcd](https://test.youbaobao.xyz:18081/book/detail?fileName=2015_Book_ContemporaryBioethics&openId=abcd)
699700
- 响应：
700701
```json
701702
{
@@ -749,7 +750,7 @@ publisher、author、category、categoryId四个参数至少需要传入一个
749750
| data | Object | 返回数据 |
750751

751752
#### 示例
752-
- 请求：`https://www.imooc.com/book/contents?fileName=2015_Book_ContemporaryBioethics`
753+
- 请求：[https://test.youbaobao.xyz:18081/book/contents?fileName=2015_Book_ContemporaryBioethics](https://test.youbaobao.xyz:18081/book/contents?fileName=2015_Book_ContemporaryBioethics)
753754
- 响应：
754755
```json
755756
{
@@ -804,7 +805,7 @@ publisher、author、category、categoryId四个参数至少需要传入一个
804805
| data | Array | 返回数据 |
805806

806807
#### 示例
807-
- 请求：`https://www.imooc.com/book/shelf/get?openId=abcd&fileName=2015_Book_ContemporaryBioethics`
808+
- 请求：[https://test.youbaobao.xyz:18081/book/shelf/get?openId=abcd&fileName=2015_Book_ContemporaryBioethics](https://test.youbaobao.xyz:18081/book/shelf/get?openId=abcd&fileName=2015_Book_ContemporaryBioethics)
808809
- 响应：
809810
```json
810811
{
@@ -847,7 +848,7 @@ publisher、author、category、categoryId四个参数至少需要传入一个
847848
| msg | String | 返回消息 |
848849

849850
#### 示例
850-
- 请求：`https://www.imooc.com/book/rank/save?openId=abcd&fileName=2015_Book_ContemporaryBioethics&rank=3`
851+
- 请求：[https://test.youbaobao.xyz:18081/book/rank/save?openId=abcd&fileName=2015_Book_ContemporaryBioethics&rank=3](https://test.youbaobao.xyz:18081/book/rank/save?openId=abcd&fileName=2015_Book_ContemporaryBioethics&rank=3)
851852
- 响应：
852853
```json
853854
{ "error_code": 0, "msg": "保存评分成功" }
@@ -874,7 +875,7 @@ publisher、author、category、categoryId四个参数至少需要传入一个
874875
| msg | String | 返回消息 |
875876

876877
#### 示例
877-
- 请求：`https://www.imooc.com/book/shelf/save?shelf=%7b%22fileName%22%3a%222016_Book_PhysiologyPsychoacousticsAndCo%22%2c%22openId%22%3a%22abcd%22%7d`
878+
- 请求：[https://test.youbaobao.xyz:18081/book/shelf/save?shelf=%7b%22fileName%22%3a%222016_Book_PhysiologyPsychoacousticsAndCo%22%2c%22openId%22%3a%22abcd%22%7d](https://test.youbaobao.xyz:18081/book/shelf/save?shelf=%7b%22fileName%22%3a%222016_Book_PhysiologyPsychoacousticsAndCo%22%2c%22openId%22%3a%22abcd%22%7d)
878879
- 响应：
879880
```json
880881
{ "error_code": 0, "msg": "加入书架成功" }
@@ -901,7 +902,7 @@ shelf的用法同加入书架API
901902
| msg | String | 返回消息 |
902903

903904
#### 示例
904-
- 请求：`https://www.imooc.com/book/shelf/remove?shelf=%7b%22fileName%22%3a%222016_Book_PhysiologyPsychoacousticsAndCo%22%2c%22openId%22%3a%22abcd%22%7d`
905+
- 请求：[https://test.youbaobao.xyz:18081/book/shelf/remove?shelf=%7b%22fileName%22%3a%222016_Book_PhysiologyPsychoacousticsAndCo%22%2c%22openId%22%3a%22abcd%22%7d](https://test.youbaobao.xyz:18081/book/shelf/remove?shelf=%7b%22fileName%22%3a%222016_Book_PhysiologyPsychoacousticsAndCo%22%2c%22openId%22%3a%22abcd%22%7d)
905906
- 响应：
906907
```json
907908
{ "error_code": 0, "msg": "移出书架成功" }
@@ -927,7 +928,7 @@ shelf的用法同加入书架API
927928
| data | Array | 返回结果 |
928929

929930
#### 示例
930-
- 请求：`https://www.imooc.com/book/shelf/get?openId=abcd`
931+
- 请求：[https://test.youbaobao.xyz:18081/book/shelf/get?openId=abcd](https://test.youbaobao.xyz:18081/book/shelf/get?openId=abcd)
931932
- 响应：
932933
```json
933934
{
@@ -969,7 +970,7 @@ shelf的用法同加入书架API
969970
| data | Object | 返回结果 |
970971

971972
#### 示例
972-
- 请求：`https://www.imooc.com/user/day?openId=abcd`
973+
- 请求：[https://test.youbaobao.xyz:18081/user/day?openId=abcd](https://test.youbaobao.xyz:18081/user/day?openId=abcd)
973974
- 响应：
974975
```json
975976
{

0 commit comments

Comments
 (0)