-
Notifications
You must be signed in to change notification settings - Fork 0
/
endpoints.json
50 lines (49 loc) · 1.66 KB
/
endpoints.json
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
{
"GET /api": {
"description": "serves up a json representation of all the available endpoints of the api",
"queries": [],
"format": "null",
"exampleResponse": "See also: recursion"
},
"GET /api/topics": {
"description": "serves an array of all topics",
"queries": [],
"format": "null",
"exampleResponse": {
"topics": [{ "slug": "football", "description": "Footie!" }]
}
},
"GET /api/articles": {
"description": "serves an array of all topics",
"queries": ["author", "topic", "sort_by", "order"],
"format": ["author=", "topic=", "sort_by"],
"exampleResponse": {
"articles": [
{
"title": "Seafood substitutions are increasing",
"topic": "cooking",
"author": "weegembump",
"body": "Text from the article..",
"created_at": "2018-05-30T15:59:13.341Z",
"votes": 0,
"comment_count": 6
}
]
}
},
"GET /api/articles/:article_id": {
"description": "Response with a single article with the specified ID",
"queries": "Any positive integer",
"format": "null",
"exampleResponse": {
"article_id": 1,
"title": "Running a Node App",
"topic": "coding",
"author": "jessjelly",
"body": "This is part two of a series on how to get up and running with Systemd and Node.js. This part dives deeper into how to successfully run your app with systemd long-term, and how to set it up in a production environment.",
"created_at": "2020-11-07T06:03:00.000Z",
"votes": 0,
"article_img_url": "https://images.pexels.com/photos/11035380/pexels-photo-11035380.jpeg?w=700&h=700"
}
}
}