-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathapiary.apib
171 lines (93 loc) · 3.05 KB
/
apiary.apib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
FORMAT: 1A
# filmyfy
Simple RESTful API of our backend Flask server. Created for communication with frontend React.js server.
# Group Users /user/
## /api/user/register/
### POST
Register a new user account.
+ Request (application/json)
+ Headers
Authorization: Token superSecretTokenOfFrontendServer
+ Body
{
"username": "MovieFan",
"name": "Movie Fan",
"email": "[email protected]",
"password": "superLongHashString"
}
## /api/user/login/
### POST
Authenticate an user.
+ Request (application/json)
+ Headers
Authorization: Token superSecretTokenOfFrontendServer
+ Body
{
"username": "MovieFan",
"password": "superLongHashString"
}
## /api/user/delete/
### DELETE
Delete an user account.
+ Request (application/json)
+ Headers
Authorization: Token superSecretTokenOfFrontendServer
+ Body
{
"username": "MovieFan",
"password": "superLongHashString"
}
# Group Movies /movie/
## /api/movie/find/
### POST
Find a movie by text string.
+ Request (application/json)
+ Headers
Authorization: Token superSecretTokenOfFrontendServer
+ Body
{
"search-string": "Straight Outta Compton"
}
## /api/movie/similar/{movie_id}/
### GET
Get list of similar movies to movie specified by `movie_id`.
+ Request (application/json)
+ Headers
Authorization: Token superSecretTokenOfFrontendServer
## /api/movie/recommend/{username}/
### GET
Recommend movies acording to user profile history.
+ Request (application/json)
+ Headers
Authorization: Token superSecretTokenOfFrontendServer
## /api/movie/seen/{username}/
### GET
Get list of seen movies by specific user profile.
+ Request (application/json)
+ Headers
Authorization: Token superSecretTokenOfFrontendServer
# Group Favourites /favourite/
## /api/favourite/add/
### POST
Add movie/actor/director/category to favourites.
+ Request (application/json)
+ Headers
Authorization: Token superSecretTokenOfFrontendServer
+ Body
{
"username": "MovieFan",
"type": "movie / actor / director / category",
"id": "movie/actor/director/category ID"
}
## /api/favourite/remove/
### DELETE
Remove movie/actor/director/category from favourites.
+ Request (application/json)
+ Headers
Authorization: Token superSecretTokenOfFrontendServer
+ Body
{
"username": "MovieFan",
"type": "movie / actor / director / category",
"id": "movie/actor/director/category ID"
}