Northcoders News API Reference
Welcome to the Northcoders News API Reference page! Below are the available endpoints that you have access to. Feel free to click on the below links or check the side navigation bar.
Articles
- GET /api/articles - Retrieve all of the available articles in the database.
- POST /api/articles - Post an article to the database.
- GET /api/articles/:article_id - Retrieve a specific article by its ID from the database.
- PATCH /api/articles/:article_id - Update the vote count for a specific article by its ID from the database.
- DELETE /api/articles/:article_id - Delete a specific article by its ID from the database.
Article Comments
- GET /api/articles/:article_id/comments - Retrieve all of the comments from a specific article by its ID from the database.
- POST /api/articles/:article_id/comments - Post a comment to a specific article by its ID from the database.
Comments
- GET /api/comments - Retrieve all of the available comments in the database.
- GET /api/comments/:comment_id - Retrieve a specific comment by its ID from the database.
- PATCH /api/comments/:comment_id - Update the vote count for a specific comment by its ID from the database.
- DELETE /api/comments/:comment_id - Delete a specific comment by its ID from the database.
Topics
- GET /api/topics - Retrieve all of the available topics in the database.
- POST /api/topics - Post a topic to the database.
Users
- GET /api/users - Retrieve all of the available users in the database.
- GET /api/users/:username - Retrieve a specific user's data by their username from the database.
- POST /api/users - Create a new user an add it to the database.