Skip to content

Commit ca976bf

Browse files
committed
🎨 RESTful API 路由命名规范
1 parent 9621f7d commit ca976bf

File tree

11 files changed

+102
-109
lines changed

11 files changed

+102
-109
lines changed

plugins/api.js

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export default ({ app: { $request } }, inject) => {
2121
* @param {string} order - POPULAR:热门、NEWEST:最新、THREE_DAYS_HOTTEST:3天内热榜、WEEKLY_HOTTEST:7天内热榜、MONTHLY_HOTTEST:30天内热榜、HOTTEST:全部热榜
2222
*/
2323
getIndexList (data = {}) {
24-
return $request.post('/v1/article/indexList', data)
24+
return $request.post('/v1/articles/indexList', data)
2525
},
2626
/**
2727
* 搜索
@@ -32,15 +32,15 @@ export default ({ app: { $request } }, inject) => {
3232
* @param {string} period - ALL:全部、D1:一天内、W1:一周内、M3:三个月内
3333
*/
3434
searchList (params = {}) {
35-
return $request.get('/v1/search/entry', params)
35+
return $request.get('/v1/articles/search', params)
3636
},
3737
/**
3838
* 获取详情页信息
3939
* @param {string} type - entry:用户等信息,entryView:文章信息
4040
* @param {string} postId - 文章id
4141
*/
4242
getDetail (params = {}) {
43-
return $request.get('/v1/article/detail', params)
43+
return $request.get('/v1/articles/detail', params)
4444
},
4545
/**
4646
* 获取文章评论
@@ -50,7 +50,7 @@ export default ({ app: { $request } }, inject) => {
5050
* @param {number} pageSize - 条数
5151
*/
5252
getCommentList (params = {}) {
53-
return $request.get('/v1/comment/entry', params)
53+
return $request.get('/v1/comments/entry', params)
5454
},
5555
/**
5656
* 获取回复列表
@@ -60,28 +60,28 @@ export default ({ app: { $request } }, inject) => {
6060
* @param {number} pageSize - 页数
6161
*/
6262
getReplyList (params = {}){
63-
return $request.get('/v1/comment/reply', params)
63+
return $request.get('/v1/comments/reply', params)
6464
},
6565
/**
6666
* 获取用户信息
6767
* @param {string} ids - 需要获取的用户id(多个以|分割)
6868
*/
6969
getMultiUser(params = {}){
70-
return $request.get('/v1/user/multiUser', params)
70+
return $request.get('/v1/users/multiUser', params)
7171
},
7272
/**
7373
* 获取用户消息
7474
* @param {string} before - 最后一条消息的 beforeAtString
7575
*/
7676
getUserNotification(params = {}){
77-
return $request.get('/v1/user/notification', params)
77+
return $request.get('/v1/users/notification', params)
7878
},
7979
/**
8080
* 获取标签详情
8181
* @param {string} tagName
8282
*/
8383
getTagDetail(params = {}){
84-
return $request.get('/v1/tag/detail', params)
84+
return $request.get('/v1/tags/detail', params)
8585
},
8686
/**
8787
* 获取对应标签的文章列表
@@ -91,22 +91,22 @@ export default ({ app: { $request } }, inject) => {
9191
* @param {string} sort - rankIndex:热门;createdAt:最新;hotIndex:最热
9292
*/
9393
getTagEntry(params = {}){
94-
return $request.get('/v1/tag/entry', params)
94+
return $request.get('/v1/tags/entry', params)
9595
},
9696
/**
9797
* 检查是否关注用户
9898
* @param {staring} currentUid
9999
* @param {string} targetUids
100100
*/
101101
isCurrentUserFollowed(params = {}){
102-
return $request.get('/v1/user/isCurrentUserFollowed', params)
102+
return $request.get('/v1/users/isCurrentUserFollowed', params)
103103
},
104104
/**
105105
* 是否点赞文章
106106
* @param {string} entryId - 文章entryId
107107
*/
108108
isArticleLike(params = {}){
109-
return $request.get('/v1/user/isArticleLike', params)
109+
return $request.get('/v1/users/isArticleLike', params)
110110
},
111111
/**
112112
* 获取用户专栏文章
@@ -116,58 +116,58 @@ export default ({ app: { $request } }, inject) => {
116116
* @param {string} order - 排序 - rankIndex:热门、createdAt:最新
117117
*/
118118
getUserPost(params = {}){
119-
return $request.get('/v1/article/userPost', params)
119+
return $request.get('/v1/articles/userPost', params)
120120
},
121121
/**
122122
* 获取推荐作者
123123
* @param {number} limit - 条数
124124
*/
125125
getRecommendAuthor(params = {}){
126-
return $request.get('/v1/recommend/recommendAuthor', params)
126+
return $request.get('/v1/recommends/recommendAuthor', params)
127127
},
128128
/**
129129
* 获取相关文章
130130
* @param {number} limit - 条数
131131
* @param {string} entryId - 文章objectId
132132
*/
133133
getRelatedEntry(params = {}){
134-
return $request.get('/v1/article/relatedEntry', params)
134+
return $request.get('/v1/articles/relatedEntry', params)
135135
},
136136
/**
137137
* 根据标签id获取相关推荐文章
138138
* @param {string} tagIds - 多个id以|分隔
139139
* @param {number} before - 最后一条的rankIndex,下一页时传入
140140
*/
141141
getRecommendEntryByTagIds(params = {}){
142-
return $request.get('/v1/article/recommendEntryByTagIds', params)
142+
return $request.get('/v1/articles/recommendEntryByTagIds', params)
143143
},
144144
/**
145145
* 点赞文章
146146
* @param {string} entryId - 文章objectId
147147
*/
148148
articleLike(data = {}){
149149
let method = data.isCollected ? 'put' : 'delete'
150-
return $request[method]('/v1/user/like', { entryId: data.entryId })
150+
return $request[method]('/v1/users/like', { entryId: data.entryId })
151151
},
152152
/**
153153
* 获取未读消息数量
154154
*/
155155
getUserNotificationNum(){
156-
return $request.get('/v1/user/userNotificationNum')
156+
return $request.get('/v1/users/userNotificationNum')
157157
},
158158
/**
159159
* 获取未读消息数量
160160
*/
161161
setUserNotificationNum(){
162-
return $request.put('/v1/user/userNotificationNum')
162+
return $request.put('/v1/users/userNotificationNum')
163163
},
164164
/**
165165
* 关注、取消关注
166166
* @param {string} follower - 关注者id
167167
* @param {string} followee - 被关注者id
168168
*/
169169
followUser(data = {}){
170-
return $request[data.method]('/v1/user/follow', {
170+
return $request[data.method]('/v1/users/follow', {
171171
follower: data.follower,
172172
followee: data.followee
173173
})
@@ -176,21 +176,21 @@ export default ({ app: { $request } }, inject) => {
176176
* 获取类目
177177
*/
178178
getCategories(){
179-
return $request.get('/v1/category/entry')
179+
return $request.get('/v1/categories/entry')
180180
},
181181
/**
182182
* 获取类目下的标签
183183
* @param {string} categoryId
184184
* @param {number} limit
185185
*/
186186
getTagByCategories(params = {}){
187-
return $request.post('/v1/category/tags', params)
187+
return $request.post('/v1/categories/tags', params)
188188
},
189189
/**
190190
* 获取已关注的标签
191191
*/
192192
getTagBySubscribed(){
193-
return $request.get('/v1/tag/subscribed')
193+
return $request.get('/v1/tags/subscribed')
194194
},
195195
/**
196196
* 获取全部标签
@@ -199,7 +199,7 @@ export default ({ app: { $request } }, inject) => {
199199
* @param {number} pageSize - 页数
200200
*/
201201
getTagByAll(params = {}){
202-
return $request.get('/v1/tag/all', params)
202+
return $request.get('/v1/tags/all', params)
203203
},
204204
/**
205205
* 搜索标签
@@ -209,14 +209,14 @@ export default ({ app: { $request } }, inject) => {
209209
* @param {number} pageSize - 页数
210210
*/
211211
getTagBySearch(params = {}){
212-
return $request.get('/v1/tag/search', params)
212+
return $request.get('/v1/tags/search', params)
213213
},
214214
/**
215215
* 关注标签
216216
* @param {string} tagId
217217
*/
218218
followTag(data = {}){
219-
return $request[data.method]('/v1/tag/subscribe', {
219+
return $request[data.method]('/v1/tags/subscribe', {
220220
tagId: data.tagId
221221
})
222222
},
@@ -227,7 +227,7 @@ export default ({ app: { $request } }, inject) => {
227227
* @param {number} pageSize - 条数
228228
*/
229229
getTopics(params = {}) {
230-
return $request.get('/v1/topic/list', params)
230+
return $request.get('/v1/topics/list', params)
231231
},
232232
/**
233233
* 获取已关注话题列表
@@ -236,42 +236,42 @@ export default ({ app: { $request } }, inject) => {
236236
* @param {number} pageSize - 条数
237237
*/
238238
getFollowedTopics(params = {}) {
239-
return $request.get('/v1/topic/followedList', params)
239+
return $request.get('/v1/topics/followedList', params)
240240
},
241241
/**
242242
* 关注话题
243243
* @param {string} topicId
244244
*/
245245
followTopic(data = {}){
246-
return $request[data.method]('/v1/topic/follow', {
246+
return $request[data.method]('/v1/topics/follow', {
247247
topicIds: data.topicIds
248248
})
249249
},
250250
/**
251251
* 获取小册类目
252252
*/
253253
getBookChannel() {
254-
return $request.get('/v1/book/channel')
254+
return $request.get('/v1/books/channel')
255255
},
256256
/**
257257
* 获取小册列表
258258
* @param {string} alias - 类目名
259259
* @param {number} pageNum
260260
*/
261261
getBooks(params = {}) {
262-
return $request.get('/v1/book/getListByLastTime', params)
262+
return $request.get('/v1/books/getListByLastTime', params)
263263
},
264264
/**
265265
* 推荐小册
266266
*/
267267
getRecommendBook() {
268-
return $request.get('/v1/recommend/books')
268+
return $request.get('/v1/recommends/books')
269269
},
270270
/**
271271
* 作者排行类目
272272
*/
273273
getAuthorChannel() {
274-
return $request.get('/v1/recommend/channel')
274+
return $request.get('/v1/recommends/channel')
275275
},
276276
/**
277277
* 作者榜单
@@ -280,7 +280,7 @@ export default ({ app: { $request } }, inject) => {
280280
* @param {number} first - 条数
281281
*/
282282
getAuthorRank(params = {}) {
283-
return $request.get('/v1/recommend/authorRank', params)
283+
return $request.get('/v1/recommends/authorRank', params)
284284
},
285285
/**
286286
* 沸点(推荐、热门、关注)
@@ -289,20 +289,20 @@ export default ({ app: { $request } }, inject) => {
289289
* @param {string} after - 分页标识
290290
*/
291291
getPinList(params = {}) {
292-
return $request.get('/v1/pin/list', params)
292+
return $request.get('/v1/pins/list', params)
293293
},
294294
/**
295295
* 单条沸点
296296
* @param {string} pinId
297297
*/
298298
getPinById(params = {}) {
299-
return $request.get('/v1/pin/byId', params)
299+
return $request.get('/v1/pins/byId', params)
300300
},
301301
/**
302302
* 推荐沸点
303303
*/
304304
getPinListByRecommend() {
305-
return $request.get('/v1/pin/hotRecommendList')
305+
return $request.get('/v1/pins/hotRecommendList')
306306
},
307307
/**
308308
* 沸点 - 话题列表
@@ -311,14 +311,14 @@ export default ({ app: { $request } }, inject) => {
311311
* @param {number} pageSize - 条数
312312
*/
313313
getPinListByTopic(params = {}) {
314-
return $request.get('/v1/pin/topicList', params)
314+
return $request.get('/v1/pins/topicList', params)
315315
},
316316
/**
317317
* 话题详情
318318
* @param {string} topicId - 话题标签
319319
*/
320320
getTopicDetail(params = {}) {
321-
return $request.get('/v1/topic/detail', params)
321+
return $request.get('/v1/topics/detail', params)
322322
},
323323
/**
324324
* 话题详情列表
@@ -328,7 +328,7 @@ export default ({ app: { $request } }, inject) => {
328328
* @param {string} sortType - 排序
329329
*/
330330
getTopicPinList(params = {}) {
331-
return $request.get('/v1/topic/pinList', params)
331+
return $request.get('/v1/topics/pinList', params)
332332
},
333333
/**
334334
* 话题参与者列表
@@ -337,7 +337,7 @@ export default ({ app: { $request } }, inject) => {
337337
* @param {number} pageSize - 条数
338338
*/
339339
getTopicAttenderList(params = {}) {
340-
return $request.get('/v1/topic/attenders', params)
340+
return $request.get('/v1/topics/attenders', params)
341341
},
342342
/**
343343
* 沸点评论列表
@@ -346,7 +346,7 @@ export default ({ app: { $request } }, inject) => {
346346
* @param {number} pageSize - 条数
347347
*/
348348
getPinCommentList(params = {}){
349-
return $request.get('/v1/comment/pin', params)
349+
return $request.get('/v1/comments/pins', params)
350350
},
351351
/**
352352
* 沸点回复列表
@@ -355,13 +355,13 @@ export default ({ app: { $request } }, inject) => {
355355
* @param {number} pageSize - 条数
356356
*/
357357
getPinReplyList(params = {}){
358-
return $request.get('/v1/comment/pinReply', params)
358+
return $request.get('/v1/comments/pinReply', params)
359359
},
360360
/**
361361
* 沸点点赞、取消点赞
362362
*/
363363
likePin(data = {}) {
364-
return $request[data.method]('/v1/pin/like', {
364+
return $request[data.method]('/v1/pins/like', {
365365
pinId: data.pinId
366366
})
367367
},

0 commit comments

Comments
 (0)