This repository has been archived by the owner on May 1, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
/
index.html
473 lines (451 loc) · 15.3 KB
/
index.html
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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
<!--
API Documentation HTML Template - 1.0.1
Copyright © 2016 Florian Nicolas
Licensed under the MIT license.
https://github.com/ticlekiwi/API-Documentation-HTML-Template
!-->
<!DOCTYPE html>
<html class="no-js" lang="en">
<head>
<meta charset="utf-8" />
<title>Swifty API - Documentation</title>
<meta
name="description"
content="Swifty — is an open source REST API created using Core PHP and OOP.
This is basically my very first REST API project. It's pretty
SIMPLE, MINIMAL & POWERFUL!"
/>
<meta name="author" content="Al Nahian" />
<meta http-equiv="cleartype" content="on" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" href="docs/css/hightlightjs-dark.css" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.8.0/highlight.min.js"></script>
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,300;0,400;0,500;1,300&family=Source+Code+Pro:wght@300&display=swap"
rel="stylesheet"
/>
<link rel="stylesheet" href="docs/css/style.css" media="all" />
<script>
hljs.initHighlightingOnLoad();
</script>
</head>
<body>
<div class="left-menu">
<div class="content-logo">
<div class="logo" title="Swifty — My First REST API Project in PHP">
<span>Swifty Docs</span>
</div>
<button class="burger-menu-icon" id="button-menu-mobile">
<svg width="34" height="34" viewBox="0 0 100 100">
<path
class="line line1"
d="M 20,29.000046 H 80.000231 C 80.000231,29.000046 94.498839,28.817352 94.532987,66.711331 94.543142,77.980673 90.966081,81.670246 85.259173,81.668997 79.552261,81.667751 75.000211,74.999942 75.000211,74.999942 L 25.000021,25.000058"
></path>
<path class="line line2" d="M 20,50 H 80"></path>
<path
class="line line3"
d="M 20,70.999954 H 80.000231 C 80.000231,70.999954 94.498839,71.182648 94.532987,33.288669 94.543142,22.019327 90.966081,18.329754 85.259173,18.331003 79.552261,18.332249 75.000211,25.000058 75.000211,25.000058 L 25.000021,74.999942"
></path>
</svg>
</button>
</div>
<div class="mobile-menu-closer"></div>
<div class="content-menu">
<div class="content-infos">
<div class="info">
<b>Author:</b>
<a href="https://alnahian2003.github.io">Al Nahian</a>
</div>
<div class="info"><b>Version:</b> 1.0</div>
<div class="info">
<b>Last Updated:</b> 2:45 PM (UTC 6+), 30 Jun, 2022
</div>
</div>
<ul>
<li class="scroll-to-link active" data-target="content-get-started">
<a>Get Started</a>
</li>
<li class="scroll-to-link" data-target="content-get-posts">
<a><code class="highlighted">GET</code> Get Blog Posts</a>
</li>
<li class="scroll-to-link" data-target="content-get-single-post">
<a><code class="highlighted">GET</code> Get Single Post</a>
</li>
<li class="scroll-to-link" data-target="content-create-post">
<a><code class="highlighted">POST</code> Create Blog Post</a>
</li>
<li class="scroll-to-link" data-target="content-update-post">
<a><code class="highlighted">PUT</code> Update Blog Posts</a>
</li>
<li class="scroll-to-link" data-target="content-delete-post">
<a><code class="highlighted">DELETE</code> Delete a Post</a>
</li>
<li class="scroll-to-link" data-target="content-get-cat">
<a>CATEGORIES</a>
</li>
</ul>
</div>
</div>
<div class="content-page">
<div class="content-code"></div>
<div class="content">
<div class="overflow-hidden content-section" id="content-get-started">
<h1>Get started</h1>
<pre>
API Endpoints
-------------
Blog Posts
==========
<code>
http://localhost/swifty/api/post
http://localhost/swifty/api/post/read.php
http://localhost/swifty/api/post/single.php?id=post_id
http://localhost/swifty/api/post/create.php
http://localhost/swifty/api/post/update.php
http://localhost/swifty/api/post/delete.php
</code>
<br>
Categories
==========
<code>
http://localhost/swifty/api/category
http://localhost/swifty/api/category/read.php
http://localhost/swifty/api/post/single.php?id=category_id
http://localhost/swifty/api/category/create.php
http://localhost/swifty/api/category/update.php
http://localhost/swifty/api/category/delete.php</code>
</pre>
<p>
Swifty — is an open source REST API created using Core PHP and OOP.
This is basically my very first REST API project. It's pretty
SIMPLE, MINIMAL & POWERFUL!
</p>
<p>
This is an Open Source API, so to use this API you don't need
<strong>API key</strong>. If you confront any error, please contact
me at
<a href="https://github.com/alnahian2003">GitHub</a>
</p>
<p>
To get started, if you downloaded this repository from GitHub then
please import
<code class="higlighted break-word">swifty.sql</code> file to your
MySQL Database. It includes required Table Schemas and some dump
data
</p>
<p>
While you're trying to
<code class="higlighted break-word">Create</code>,
<code class="higlighted break-word">Update</code>, or
<code class="higlighted break-word">Delete</code> through API, make
sure your provided data are in JSON format. Because
<code class="higlighted break-word">header</code> only accepts
<code class="higlighted break-word"
>Content-Type: application/json</code
>
in these requests.
</p>
</div>
<div class="overflow-hidden content-section" id="content-get-posts">
<h2>Get Blog Posts</h2>
<p>
To get blog posts you need to make a
<code class="higlighted break-word">GET</code> call to the following
url :<br />
<code class="higlighted break-word"
>http://localhost/switfy/api/post/read.php</code
>
</p>
<br />
<pre><code class="json highlighted">Get Blog Post Result Format Example :
[
{
"id": "1",
"category_id": "5",
"category_name": "Trending",
"title": "Post Title",
"body": "The Blog Post",
"author": "Author Name",
"created_at": "2022-06-29 16:56:26"
} ...
]</code></pre>
<h3>
This will provide all the blog posts. So, you don't have to pass any
QUERY PARAMETERS
</h3>
</div>
<div
class="overflow-hidden content-section"
id="content-get-single-post"
>
<h2>Get a Single Blog Post</h2>
<p>
To get blog a specific post you need to make a
<code class="higlighted break-word">GET</code> call to the following
url :<br />
<code class="higlighted break-word"
>http://localhost/switfy/api/post/single.php?id=post_id</code
>
</p>
<br />
<pre>
The URL should look like:
<code>
http://localhost/switfy/api/post/single.php?id=1
</code>
<code class="json highlighted">
Result if any post exists:
[
{
"id": "1",
"category_id": "5",
"category_name": "Trending",
"title": "Post Title",
"body": "The Blog Post",
"author": "Author Name",
"created_at": "2022-06-29 16:56:26"
}
]</code></pre>
<h4>Just pass the post id to get the specific post from API</h4>
</div>
<div class="overflow-hidden content-section" id="content-create-post">
<h2>Create a Blog Post</h2>
<p>
To create a new blog post you need to make a
<code class="higlighted break-word">POST</code> request to the
following url :<br />
<code class="higlighted break-word"
>http://localhost/switfy/api/post/create.php</code
>
</p>
<br />
<pre><code class="json highlighted">
Create Blog Post JSON format Example :
{
"category_id": int,
"title": "string",
"body": "string",
"author": "string",
}
On Success, Response Message Will Be:
{
"message": "Post Created Successfully"
}
</code></pre>
<h4>QUERY PARAMETERS</h4>
<table class="central-overflow-x">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>category_id</td>
<td>Integer</td>
<td>Post Category</td>
</tr>
<tr>
<td>title</td>
<td>String</td>
<td>Your post title</td>
</tr>
<tr>
<td>body</td>
<td>String</td>
<td>Your post content</td>
</tr>
<tr>
<td>author</td>
<td>String</td>
<td>Post author name</td>
</tr>
</tbody>
</table>
</div>
<div class="overflow-hidden content-section" id="content-update-post">
<h2>Update a Blog Post</h2>
<p>
To update a new blog post you need to make a
<code class="higlighted break-word">PUT</code> request to the
following url :<br />
<code class="higlighted break-word"
>http://localhost/switfy/api/post/update.php</code
>
</p>
<br />
<pre><code class="json highlighted">
Update Blog Post JSON format Example :
{
"id": 0,
"category_id": int,
"title": "string",
"body": "string",
"author": "string",
}
On Success, The Response Will Be:
{
"message": "Post Updated Successfully"
}
</code></pre>
<h4>QUERY PARAMETERS</h4>
<table class="central-overflow-x">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>Integer</td>
<td>Existing Post Id</td>
</tr>
<tr>
<td>category_id</td>
<td>Integer</td>
<td>Post Category</td>
</tr>
<tr>
<td>title</td>
<td>String</td>
<td>Your post title</td>
</tr>
<tr>
<td>body</td>
<td>String</td>
<td>Your post content</td>
</tr>
<tr>
<td>author</td>
<td>String</td>
<td>Post author name</td>
</tr>
</tbody>
</table>
</div>
<div class="overflow-hidden content-section" id="content-delete-post">
<h2>Delete a Blog Post</h2>
<p>
To delte a blog post you need to make a DELETE request to the
following url :<br />
<code class="higlighted break-word"
>http://localhost/switfy/api/post/delete.php</code
>
</p>
<br />
<pre><code class="json highlighted">
Delete Blog Post JSON format Example :
{
"id": 0
}
Success Response Will Be
{
"message": "✅ Category Deleted!"
}</code></pre>
<h4>QUERY PARAMETERS</h4>
<table class="central-overflow-x">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>Integer</td>
<td>Just provide the Post Id to be deleted</td>
</tr>
</tbody>
</table>
</div>
<div class="overflow-hidden content-section" id="content-get-cat">
<h2>Post Categories</h2>
<h2>
<code class="higlighted break-word"
>All the process for Categories are same as Posts!</code
>
</h2>
</div>
</div>
</div>
<!-- Github Corner Ribbon - to remove (Ribbon created with : http://tholman.com/github-corners/ )-->
<a
href="https://github.com/alnahian2003/swifty"
class="github-corner"
aria-label="View source on Github"
title="View source on Github"
><svg
width="80"
height="80"
viewBox="0 0 250 250"
style="
z-index: 99999;
fill: #70b7fd;
color: #fff;
position: fixed;
top: 0;
border: 0;
right: 0;
"
aria-hidden="true"
>
<path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>
<path
d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2"
fill="currentColor"
style="transform-origin: 130px 106px"
class="octo-arm"
></path>
<path
d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z"
fill="currentColor"
class="octo-body"
></path></svg></a
><style>
.github-corner:hover .octo-arm {
animation: octocat-wave 560ms ease-in-out;
}
@keyframes octocat-wave {
0%,
100% {
transform: rotate(0);
}
20%,
60% {
transform: rotate(-25deg);
}
40%,
80% {
transform: rotate(10deg);
}
}
@media (max-width: 500px) {
.github-corner:hover .octo-arm {
animation: none;
}
.github-corner .octo-arm {
animation: octocat-wave 560ms ease-in-out;
}
}
@media only screen and (max-width: 680px) {
.github-corner > svg {
right: auto !important;
left: 0 !important;
transform: rotate(270deg) !important;
}
}
</style>
<!-- END Github Corner Ribbon - to remove -->
<script src="docs/js/script.js"></script>
</body>
</html>