Showing
1 changed file
with
249 additions
and
0 deletions
全能思维课/外教思维课.md
0 → 100644
1 | +> env.url: `https`://api[api-online.test].boxfish.cn | ||
2 | +> | ||
3 | +> notes: | ||
4 | +> | ||
5 | + * `默认所有接口都要携带token` access_token | ||
6 | + | ||
7 | +# 外教思维课程目标【小结】接口 | ||
8 | + * URL {env.url}/foreign/course/{lesson}/summary | ||
9 | + * GET Method | ||
10 | + * path 参数: | ||
11 | + | ||
12 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
13 | + |-------------|--------|------|----------|------| | ||
14 | + | lesson | String | Y |课程id| | | ||
15 | + | ||
16 | + | ||
17 | + * response: | ||
18 | + | ||
19 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
20 | + |-------------|--------|------|----------|------| | ||
21 | + | national_knowledge | List | N |大纲知识点| | | ||
22 | + | international_knowledge | List | N |国际知识点| | | ||
23 | + | words | List | N |单词| | | ||
24 | + | phrases | List | N |短句| | | ||
25 | + | sentences | List | N |核心句子| | | ||
26 | + | dialogs | List | N |核心句子| | | ||
27 | + | ||
28 | + | ||
29 | + contents | ||
30 | + | ||
31 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
32 | + |-------------|--------|------|----------|------| | ||
33 | + | value | String | Y |内容| | | ||
34 | + | definition | String | N |翻译| | | ||
35 | + | actor | String | N |头像| | | ||
36 | + | ||
37 | + | ||
38 | + dialogs 对话 | ||
39 | + | ||
40 | + 头像的取法沿用课程内对话模版的取法,当 actors 字段不为空时,从actors 取到对应图片的 md5 使用 api.boxfish.cn/data/{md5} 获取对应的头像图片,当actors为空时,使用app内静态资源显示。 | ||
41 | + | ||
42 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
43 | + |-------------|--------|------|----------|------| | ||
44 | + | name | String | Y |显示的名字| | | ||
45 | + | type | String | Y |类型| | | ||
46 | + | actors | List | N |头像列表| | | ||
47 | + | contents | List | N |对话内容| | | ||
48 | + | ||
49 | + contents | ||
50 | + | ||
51 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
52 | + |-------------|--------|------|----------|------| | ||
53 | + | actor | String | N |头像| | | ||
54 | + | value | String | Y |内容| | | ||
55 | + | definition | String | N |翻译| | | ||
56 | +```json | ||
57 | + { | ||
58 | + "national_knowledge": [ | ||
59 | + "stop to do sth.", | ||
60 | + "动词短语" | ||
61 | + ], | ||
62 | + "international_knowledge": [ | ||
63 | + "人际交往-禁止" | ||
64 | + ], | ||
65 | + "dialogs": [{ | ||
66 | + "name": "图片场景对话", | ||
67 | + "type": "image_short_dialog", | ||
68 | + "contents": [{ | ||
69 | + "actor": "woman", | ||
70 | + "value": "The teacher stopped to stare at the naughty kid.", | ||
71 | + "definition": "老师停了下来,看着那个淘气的孩子。" | ||
72 | + }, | ||
73 | + { | ||
74 | + "actor": "man", | ||
75 | + "value": "I bet he is in trouble.", | ||
76 | + "definition": "我敢打赌他有麻烦了。" | ||
77 | + } | ||
78 | + ] | ||
79 | + }, | ||
80 | + { | ||
81 | + "name": "视频场景对话", | ||
82 | + "type": "video_short_dialog", | ||
83 | + "actors": { | ||
84 | + "Shrek": "b305dd409c63b92e0ebb8e304b344fe8", | ||
85 | + "Fiona": "9775d775dabbe1a5d21061e1f8438f88" | ||
86 | + }, | ||
87 | + "contents": [{ | ||
88 | + "actor": "Fiona", | ||
89 | + "value": "It'll take that long? Shouldn't we stop to make camp?", | ||
90 | + "definition": "要那么久吗?我们不应该停下来扎营吗?" | ||
91 | + }, | ||
92 | + { | ||
93 | + "actor": "Shrek", | ||
94 | + "value": "No, that'll take longer.", | ||
95 | + "definition": "不行,那样会更久。" | ||
96 | + } | ||
97 | + ] | ||
98 | + } | ||
99 | + ], | ||
100 | + "words": [{ | ||
101 | + "value": "play", | ||
102 | + "definition": "v.玩" | ||
103 | + }, | ||
104 | + { | ||
105 | + "value": "TV" | ||
106 | + } | ||
107 | + ], | ||
108 | + "phrases": [{ | ||
109 | + "value": "do well", | ||
110 | + "definition": "" | ||
111 | + }], | ||
112 | + "sentences": [{ | ||
113 | + "value": "The cat is staring at a fish.", | ||
114 | + "definition": "这只猫正盯着一条鱼。" | ||
115 | + }, | ||
116 | + { | ||
117 | + "value": "She is a naughty girl.", | ||
118 | + "definition": "她是一个淘气的女孩。" | ||
119 | + }, | ||
120 | + { | ||
121 | + "value": "She is in trouble.", | ||
122 | + "definition": "她有麻烦了。" | ||
123 | + } | ||
124 | + ] | ||
125 | + } | ||
126 | +}``` | ||
127 | + | ||
128 | +# 用户成绩接口 | ||
129 | + * URL {env.url}/user/omnipotent/foreign/lesson/{lesson}/learning | ||
130 | + * GET Method | ||
131 | + * path 参数: | ||
132 | + | ||
133 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
134 | + |-------------|--------|------|----------|------| | ||
135 | + | lesson | String | Y |课程id| | | ||
136 | + | ||
137 | + | ||
138 | + * response: | ||
139 | + | ||
140 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
141 | + |-------------|--------|------|----------|------| | ||
142 | + | user_id | Long | N |用户ID| | | ||
143 | + | completion_grade | String | N |本课成绩| | | ||
144 | + | national_knowledge | List | N |大纲知识点| | | ||
145 | + | international_knowledge | List | N |国际知识点| | | ||
146 | + | words | List | N |单词| | | ||
147 | + | phrases | List | N |短句| | | ||
148 | + | sentences | List | N |核心句子| | | ||
149 | + | dialogs | List | N |核心句子| | | ||
150 | + | ||
151 | + | ||
152 | + contents | ||
153 | + | ||
154 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
155 | + |-------------|--------|------|----------|------| | ||
156 | + | value | String | Y |内容| | | ||
157 | + | definition | String | N |翻译| | | ||
158 | + | actor | String | N |头像| | | ||
159 | + | ||
160 | + | ||
161 | + dialogs 对话 | ||
162 | + | ||
163 | + 头像的取法沿用课程内对话模版的取法,当 actors 字段不为空时,从actors 取到对应图片的 md5 使用 api.boxfish.cn/data/{md5} 获取对应的头像图片,当actors为空时,使用app内静态资源显示。 | ||
164 | + | ||
165 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
166 | + |-------------|--------|------|----------|------| | ||
167 | + | name | String | Y |显示的名字| | | ||
168 | + | type | String | Y |类型| | | ||
169 | + | actors | List | N |头像列表| | | ||
170 | + | contents | List | N |对话内容| | | ||
171 | + | ||
172 | + contents | ||
173 | + | ||
174 | + |参数名 | 类型 | 必填 | 说明 | 示例 | | ||
175 | + |-------------|--------|------|----------|------| | ||
176 | + | actor | String | N |头像| | | ||
177 | + | value | String | Y |内容| | | ||
178 | + | definition | String | N |翻译| | | ||
179 | +```json | ||
180 | + { | ||
181 | + "national_knowledge": [ | ||
182 | + "stop to do sth.", | ||
183 | + "动词短语" | ||
184 | + ], | ||
185 | + "international_knowledge": [ | ||
186 | + "人际交往-禁止" | ||
187 | + ], | ||
188 | + "dialogs": [{ | ||
189 | + "name": "图片场景对话", | ||
190 | + "type": "image_short_dialog", | ||
191 | + "contents": [{ | ||
192 | + "actor": "woman", | ||
193 | + "value": "The teacher stopped to stare at the naughty kid.", | ||
194 | + "definition": "老师停了下来,看着那个淘气的孩子。" | ||
195 | + }, | ||
196 | + { | ||
197 | + "actor": "man", | ||
198 | + "value": "I bet he is in trouble.", | ||
199 | + "definition": "我敢打赌他有麻烦了。" | ||
200 | + } | ||
201 | + ] | ||
202 | + }, | ||
203 | + { | ||
204 | + "name": "视频场景对话", | ||
205 | + "type": "video_short_dialog", | ||
206 | + "actors": { | ||
207 | + "Shrek": "b305dd409c63b92e0ebb8e304b344fe8", | ||
208 | + "Fiona": "9775d775dabbe1a5d21061e1f8438f88" | ||
209 | + }, | ||
210 | + "contents": [{ | ||
211 | + "actor": "Fiona", | ||
212 | + "value": "It'll take that long? Shouldn't we stop to make camp?", | ||
213 | + "definition": "要那么久吗?我们不应该停下来扎营吗?" | ||
214 | + }, | ||
215 | + { | ||
216 | + "actor": "Shrek", | ||
217 | + "value": "No, that'll take longer.", | ||
218 | + "definition": "不行,那样会更久。" | ||
219 | + } | ||
220 | + ] | ||
221 | + } | ||
222 | + ], | ||
223 | + "words": [{ | ||
224 | + "value": "play", | ||
225 | + "definition": "v.玩" | ||
226 | + }, | ||
227 | + { | ||
228 | + "value": "TV" | ||
229 | + } | ||
230 | + ], | ||
231 | + "phrases": [{ | ||
232 | + "value": "do well", | ||
233 | + "definition": "" | ||
234 | + }], | ||
235 | + "sentences": [{ | ||
236 | + "value": "The cat is staring at a fish.", | ||
237 | + "definition": "这只猫正盯着一条鱼。" | ||
238 | + }, | ||
239 | + { | ||
240 | + "value": "She is a naughty girl.", | ||
241 | + "definition": "她是一个淘气的女孩。" | ||
242 | + }, | ||
243 | + { | ||
244 | + "value": "She is in trouble.", | ||
245 | + "definition": "她有麻烦了。" | ||
246 | + } | ||
247 | + ] | ||
248 | + } | ||
249 | +}``` |
-
Please register or login to post a comment