This is a backend API for a blog application with different user roles such as writers, editors, admin, and normal users (called learners).The API provides a set of endpoints that enable writers and editors to perform various operations, such as creating, reading, updating, and deleting blogs.
The API is built using modern web development frameworks and technologies, such as Node.js, Express, Mongoose. It uses authentication and authorization mechanisms, such as JSON Web Tokens (JWT) with public/private keys, to ensure secure access to the data and restrict unauthorized actions.
The API provides the following endpoints:
Auth:
| Description | Method | endpoint |
|---|---|---|
| allow users to signup | POST |
/api/v1/signup/basic |
| allow users to login | POST |
/api/v1/login/basic |
| allow users to logout | DELETE |
/api/v1/logout |
| allow users to refersh their tokens | POST |
/api/v1/refersh |
Profile
| Description | Method | endpoint |
|---|---|---|
| allow users to get their private profiles details | GET |
/api/v1/profile |
| allow users to update their private profile detials | POST |
/api/v1/profile |
Blog
| Description | Method | endpoint |
|---|---|---|
| allow writers to add their blog | POST |
/api/v1/blog/writer |
| allow writers to get their blog | GET |
/api/v1/blog/writer/:id |
| allow writers to update their blog | PUT |
/api/v1/blog/writer/:id |
| allow writers to delete their blog | DELETE |
/api/v1/blog/writer/:id |
| allow writers to submit their blog | PUT |
/api/v1/blog/writer/submit/:id |
| allow writers to withdraw their blog | PUT |
/api/v1/blog/writer/withdraw/:id |
| allow writers to get all their draft blog | GET |
/api/v1/blog/writer/drafts |
| allow writers to get all their submitted blog | GET |
/api/v1/blog/writer/submitted |
| allow writers to get all their published blog | GET |
/api/v1/blog/writer/published |
| allow editors to get all published blogs | GET |
/api/v1/blog/editor/published |
| allow editors to get all submitted blogs | GET |
/api/v1/blog/editor/submitted |
| allow editors to get all drafts blogs | GET |
/api/v1/blog/editor/drafts |
| allow editors to get data of a single blog | GET |
/api/v1/blog/editor/:id |
| allow editors to delete a blog | DELETE |
/api/v1/blog/editor/:id |
| allow editors to publish a blog | PUT |
/api/v1/blog/editor/publish/:id |
| allow editors to unpublish a blog | PUT |
/api/v1/blog/editor/unpublish/:id |
| allow learners to get a blog by url(Cache used) | GET |
/api/v1/blog/url |
| allow learners to get a blog by id (Cache used) | GET |
/api/v1/blog/id/:id |
| allow learners to get similar blogs | GET |
/api/v1/blog/similar/id/:id |
| allow learners to get latest blogs | GET |
/api/v1/blog/latest |
| allow learners to get blogs by tags | GET |
/api/v1/blog/tag/:tag |