Repository for backend cohort - Technetium
- Author Model
{ fname: { mandatory}, lname: {mandatory}, title: {mandatory, enum[Mr, Mrs, Miss]}, email: {mandatory, valid email, unique}, password: {mandatory} }
- Blogs Model
{ title: {mandatory}, body: {mandatory}, authorId: {mandatory, refs to author model}, tags: {array of string}, category: {string, mandatory}, subcategory: {array of string, examples[technology-[web development, mobile development, AI, ML etc]] }, createdAt, updatedAt, deletedAt: {when the document is deleted}, isDeleted: {boolean, default: false}, publishedAt: {when the blog is published}, isPublished: {boolean, default: false}}
- Create an author - atleast 5 authors
- Create a author document from request body.
Endpoint: BASE_URL/authors
-
Create a blog document from request body. Get authorId in request body only.
-
Make sure the authorId is a valid authorId by checking the author exist in the authors collection.
-
Return HTTP status 201 on a succesful blog creation. Also return the blog document. The response should be a JSON object like this
-
Create atleast 5 blogs for each author
-
Return HTTP status 400 for an invalid request with a response body like this
- Returns all blogs in the collection that aren't deleted and are published
- Return the HTTP status 200 if any documents are found. The response structure should be like this
- If no documents are found then return an HTTP status 404 with a response like this
- Filter blogs list by applying filters. Query param can have any combination of below filters.
- By author Id
- By category
- List of blogs that have a specific tag
- List of blogs that have a specific subcategory example of a query url: blogs?filtername=filtervalue&f2=fv2
- Updates a blog by changing the its title, body, adding tags, adding a subcategory. (Assuming tag and subcategory received in body is need to be added)
- Updates a blog by changing its publish status i.e. adds publishedAt date and set published to true
- Check if the blogId exists (must have isDeleted false). If it doesn't, return an HTTP status 404 with a response body like this
- Return an HTTP status 200 if updated successfully with a body like this
- Also make sure in the response you return the updated blog document.
- Check if the blogId exists( and is not deleted). If it does, mark it deleted and return an HTTP status 200 without any response body.
- If the blog document doesn't exist then return an HTTP status of 404 with a body like this
- Delete blog documents by category, authorid, tag name, subcategory name, unpublished
- If the blog document doesn't exist then return an HTTP status of 404 with a body like this
- Add authentication and authroisation feature
- Allow an author to login with their email and password. On a successful login attempt return a JWT token contatining the authorId in response body like this
- If the credentials are incorrect return a suitable error message with a valid HTTP status code
- Add an authorisation implementation for the JWT token that validates the token before every protected endpoint is called. If the validation fails, return a suitable error message with a corresponding HTTP status code
- Protected routes are create a blog, edit a blog, get the list of blogs, delete a blog(s)
- Set the token, once validated, in the request -
x-api-key - Use a middleware for authentication purpose.
- Make sure that only the owner of the blogs is able to edit or delete the blog.
- In case of unauthorized access return an appropirate error message.
- To test these apis create a new collection in Postman named Project 1 Blogging
- Each api should have a new request in this collection
- Each request in the collection should be rightly named. Eg Create author, Create blog, Get blogs etc
- Each member of each team should have their tests in running state
Refer below sample
{
status: true,
data: {
}
}{
status: false,
message: ""
}{
"status": true,
"data": {
"_id": "63edd170875e5650d89ab9b8",
"fname": "John",
"lname": "Wick",
"title": "Mr",
"email": "john4614@gmail.com",
"password": "pass1234",
"createdAt": "2023-02-16T06:47:12.993Z",
"updatedAt": "2023-02-16T06:47:12.993Z",
"__v": 0
}
}{
status: true,
data: {
"title": "How to win friends",
"body": "Blog body",
"tags": ["Book", "Friends", "Self help"],
"category": "Book",
"subcategory": ["Non fiction", "Self Help"],
"published": false,
"publishedAt": "", // if published is true publishedAt will have a date 2021-09-17T04:25:07.803Z
"deleted": false,
"deletedAt": "", // if deleted is true deletedAt will have a date 2021-09-17T04:25:07.803Z,
"createdAt": "2021-09-17T04:25:07.803Z",
"updatedAt": "2021-09-17T04:25:07.803Z",
}
}{
"status": true,
"message": "Blogs list",
"data": [
{
"tags": ["programming","coding"],
"subcategory": ["web development","mobile development"],
"isPublished": true,
"publishedAt": null,
"isDeleted": false,
"deletedAt": null,
"_id": "626f6af87528876cb6361cfe",
"title": "Extreme Developer 101",
"body": "Code more, learn more.",
"authorId": "626f6aec7528876cb6361cfa",
"category": "technology",
"createdAt": "2022-05-02T05:24:08.546Z",
"updatedAt": "2022-05-02T05:27:46.791Z",
"__v": 0
},
{
"tags": ["movies"],
"subcategory": ["aliens"],
"isPublished": true,
"publishedAt": "2022-05-02T05:49:04.679Z",
"isDeleted": false,
"deletedAt": null,
"_id": "626f70d07528876cb6361d2d",
"title": "Best sci-fi movies of the year",
"body": "blah blah",
"authorId": "626f6d127528876cb6361d09",
"category": "entertainment",
"createdAt": "2022-05-02T05:49:04.681Z",
"updatedAt": "2022-05-02T05:49:04.681Z",
"__v": 0
},
}]
{
"status": true,
"message": "Blog updated successfully",
"data": {
"tags": [
"movies",
"story"
],
"subcategory": [
"aliens",
"cinema"
],
"isPublished": false,
"publishedAt": null,
"isDeleted": false,
"deletedAt": null,
"_id": "63edd36c875e5650d89ab9c1",
"title": "new title",
"body": "new body",
"authorId": "63edd170875e5650d89ab9b8",
"category": "novel",
"createdAt": "2023-02-16T06:55:40.352Z",
"updatedAt": "2023-02-16T06:55:43.976Z",
"__v": 0
}
}{
status: true,
message: ""
}{
status: true,
data: {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdXRob3JJZCI6IjYyZmUzYmUzMzY2ZmFkNDZjY2Q1MzI3ZiIsImlhdCI6MTY2MDgzMDA4MywiZXhwIjoxNjYwODY2MDgzfQ.mSo-TLyRlGhMNcy4ftEvvIlCHlyEqpaFZc-iBth4lfg"
}
}