Graduation-Project-HYF/api_endpoints.yml at develop · burhan1997/Graduation-Project-HYF · GitHub

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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
api:
  version: 1.0
  base_url: https://localhost:8080/api

endpoints:
  - path: /user
    method: GET
    description: Get list of users
    parameters:
      - name: page
        type: integer
        required: false
        description: Page number for pagination
      - name: limit
        type: integer
        required: false
        description: Number of users per page

  - path: /user
    method: POST
    description: Create a new user
    parameters:
      - name: username
        type: string
        required: true
        description: Username for the new user
      - name: email
        type: string
        required: true
        description: Email address of the new user
      - name: password
        type: string
        required: true
        description: Password for the new user

  - path: /user/{id}
    method: GET
    description: Get details of a specific user
    parameters:
      - name: id
        type: string
        required: true
        description: ID of the user

  - path: /user/{id}
    method: PUT
    description: Update details of a specific user
    parameters:
      - name: id
        type: string
        required: true
        description: ID of the user
      - name: email
        type: string
        required: false
        description: New email address of the user
      - name: password
        type: string
        required: false
        description: New password for the user

  - path: /{id}
    method: DELETE
    description: Delete a specific user
    parameters:
      - name: id
        type: string
        required: true
        description: ID of the user

  - path: /sign-up
    method: POST
    description: Register a new user
    parameters:
      - name: username
        type: string
        required: true
        description: Username for the new user
      - name: email
        type: string
        required: true
        description: Email address of the new user
      - name: password
        type: string
        required: true
        description: Password for the new user

  - path: /sign-in
    method: POST
    description: Sign in an existing user
    parameters:
      - name: username
        type: string
        required: true
        description: Username of the user
      - name: password
        type: string
        required: true
        description: Password of the user

  - path: /messages
    method: GET
    description: Get list of messages
    parameters:
      - name: user_id
        type: string
        required: false
        description: ID of the user to filter messages by user
      - name: page
        type: integer
        required: false
        description: Page number for pagination
      - name: limit
        type: integer
        required: false
        description: Number of messages per page

  - path: /messages
    method: POST
    description: Send a new message
    parameters:
      - name: user_id
        type: string
        required: true
        description: ID of the user sending the message
      - name: content
        type: string
        required: true
        description: Content of the message

  - path: /update
    method: PUT
    description: Update user information
    parameters:
      - name: user_id
        type: string
        required: true
        description: ID of the user
      - name: email
        type: string
        required: false
        description: New email address of the user
      - name: password
        type: string
        required: false
        description: New password for the user

  - path: /update/{id}
    method: PUT
    description: Update specific user information
    parameters:
      - name: id
        type: string
        required: true
        description: ID of the user
      - name: email
        type: string
        required: false
        description: New email address of the user
      - name: password
        type: string
        required: false
        description: New password for the user

  - path: /hobbies
    method: GET
    description: Get list of hobbies
    parameters: []

  - path: /hobbies
    method: POST
    description: Create a new hobby
    parameters:
      - name: name
        type: string
        required: true
        description: Name of the hobby
      - name: description
        type: string
        required: false
        description: Description of the hobby

  - path: /hobbies/{id}
    method: GET
    description: Get details of a specific hobby
    parameters:
      - name: id
        type: string
        required: true
        description: ID of the hobby

  - path: /hobbies/{id}
    method: PUT
    description: Update details of a specific hobby
    parameters:
      - name: id
        type: string
        required: true
        description: ID of the hobby
      - name: name
        type: string
        required: false
        description: Name of the hobby
      - name: description
        type: string
        required: false
        description: Description of the hobby

  - path: /hobbies/{id}
    method: DELETE
    description: Delete a specific hobby
    parameters:
      - name: id
        type: string
        required: true
        description: ID of the hobby

  - path: /reviews
    method: GET
    description: Get list of reviews
    parameters: []

  - path: /reviews
    method: POST
    description: Create a new review
    parameters:
      - name: hobby_id
        type: string
        required: true
        description: ID of the hobby being reviewed
      - name: user_id
        type: string
        required: true
        description: ID of the user writing the review
      - name: content
        type: string
        required: true
        description: Content of the review

  - path: /reviews/{id}
    method: GET
    description: Get details of a specific review
    parameters:
      - name: id
        type: string
        required: true
        description: ID of the review

  - path: /reviews/{id}
    method: PUT
    description: Update details of a specific review
    parameters:
      - name: id
        type: string
        required: true
        description: ID of the review
      - name: content
        type: string
        required: false
        description: Updated content of the review

  - path: /reviews/{id}
    method: DELETE
    description: Delete a specific review
    parameters:
      - name: id
        type: string
        required: true
        description: ID of the review