Note that scb is simply what I have for the local server in the hosts file. Substitute the IP address or whatever mapping you have for the local server during dev. By default, that IP address is 192.168.123.10.
The following routes interact with articles (this is where you submit which articles are clickbait):
| Verb | Route | Result |
|---|---|---|
| GET | scb/api/articles |
Returns all of the existing articles. |
| GET | scb/api/articles/{article} |
Returns the article for which {article} is the id. |
| GET | scb/api/users/{user}/articles |
Returns the articles for the {user}, which is the id of the user. |
| POST | scb/api/articles |
Creates a new article in the database and returns it. Specify nameURI and userID as parameters. Example: http://scb/api/articles?nameURI=urihere&userID=5 |
| PUT/PATCH | scb/api/articles/{article} |
Updates the specified article, where {article} is the id of the article. Specify nameURI, userID, or both as parameters. It will return the updated article. |
| DELETE | scb/api/articles/{article} |
Soft deletes the article for which {article} is the id. This simply sets isDeleted to 1 in the database, which means it will not be returned in the list of all articles. It then returns the article. |
The following interact with users:
| Verb | Route | Result |
|---|---|---|
| GET | scb/api/users |
Returns all of the existing users. |
| GET | scb/api/users/{user} |
Returns the user for which {user} is the id. |
| GET | scb/api/articles/{article}/user |
Returns the user who initially reported the {article}. |
| POST | scb/api/users |
Creates a new user in the database and returns it. Specify email, name, and password as parameters. |
| PUT/PATCH | scb/api/users/{user} |
Updates the specified user, where {user} is the id of the user. Specify email, name, password or all as parameters. It will return the updated user. |
The following routes interact with posts. (Posts are the 'spoilers' to the clickbait articles above.)
| Verb | Route | Result |
|---|---|---|
| GET | scb/api/posts |
Returns all of the existing posts. |
| GET | scb/api/posts/{post} |
Returns the post for which {post} is the id. |
| GET | scb/api/users/{user}/posts |
Returns the posts for the given {user} (which is again the user id.) |
| GET | scb/api/articles/{article}/posts |
Returns the posts for the given {article} (which is again the article id.) |
| GET | scb/api/posts/{post}/votes |
Returns the votes (upvotes and downvotes) for the given {post} (which is again the post id.) |
| PUT | scb/api/posts/{post}/upvote |
Upvotes the post by 1 and returns an integer value with the new number of upvotes. {post} is the id of the post. |
| PUT | scb/api/posts/{post}/downvote |
Downvotes the post by 1 and returns an integer value with the new number of downvotes. {post} is the id of the post. |
| POST | scb/api/posts |
Creates a new post in the database and returns it. Specify user_id, article_id, and text as parameters. Text can be up to 140 characters. |
| PUT/PATCH | scb/api/posts/{post} |
Updates the specified post, where {post} is the id of the user. You can only specify text as a parameter. This will return the specified post with the update. |