Personal note rest API

Pre Requirements

NodeJs v12.x.x higher version
MongoDB 5.x.x higher version

Node module install
Start Project
Project description
Assumptions
APIS
Technologies

How To Start Project

Node module install

npm install

Start Project

npm start

Server start : http://localhost:8000

Project description

This is a REST API based project developed in NodeJs to manage personal notes. The content is saved in .txt files. The content is not stored in the Database. And the text files are saved in the server whereas the other details such as user ID, file name, title, and created time. Based on user preference the user can save the file in a.txt file format or .zip archive file format. The text can be retrieved in two ways which are if it’s an archived file it can be retrieved in archived format and if the content is saved in a text file it can be retrieved in the same file format. The content in the text file can be modified and saved back either as an archived file or a text file.

Assumptions

When creating a note it’s essential to add the User ID.
Initially at the file create stage the user can either archive the file or save it as a file itself. But the archived file cannot be reverted back into the non-archived stage.
The list of archived files or non-archived files can be obtained based on user ID.
The text in a non-archived file can be
In a non-archived file, the text can be edited
To authenticate user Id must be sent in the header as an 'access-token'. Then only access will be provided to update, delete, and read.

APIs

API postman samples

https://schema.getpostman.com/json/collection/v2.1.0/collection.json

add a note

create a new note

http://localhost:8000/api/v1/note/add

response at success

{
    "status": "success",
    "message": "Success, create a new note."
}

response at failure

{
    "error": "error",
    "message": "The file has not been added, check again."
}

get archive or text files by userId

http://localhost:8000/api/v1/note/unarchive/1

response at success (unarchived)

{
    "status": "success",
    "message": "The unarchived list has been obtained.",
    "data": [
        {
            "isArchive": false,
            "_id": "5ff98240fb6f904188d31542",
            "userId": "1",
            "titile": "my pet",
            "fileName": "kW8TTWbe1s.txt",
            "createdAt": "2021-01-09T10:15:28.650Z",
            "updatedAt": "2021-01-09T10:15:28.650Z",
            "__v": 0
        }
    ]
}

response at success (archived)

http://localhost:8000/api/v1/note/archive/1

{
    "status": "success",
    "message": "The archived list has been obtained.",
    "data": [
        {
            "isArchive": true,
            "_id": "5ff98080d78e2606702dd7ef",
            "userId": "1",
            "titile": "about me",
            "fileName": "TdHHKNXjuz.txt.zip",
            "createdAt": "2021-01-09T10:08:00.215Z",
            "updatedAt": "2021-01-09T10:08:00.215Z",
            "__v": 0
        }
    ]
}

get details of a note

http://localhost:8000/api/v1/note/5ff9576ef510ce034cabbe0e

response at success

{
    "status": "success",
    "message": "The unarchived list has been obtained.",
    "data": [
        {
            "isArchive": false,
            "_id": "5ff98240fb6f904188d31542",
            "userId": "1",
            "titile": "my pet",
            "fileName": "kW8TTWbe1s.txt",
            "createdAt": "2021-01-09T10:15:28.650Z",
            "updatedAt": "2021-01-09T10:15:28.650Z",
            "__v": 0
        }
    ]
}

response at failure

{
    "error": "error",
    "message": "Invalid user id."
}

chanage file format to archived

http://localhost:8000/api/v1/note/toArchive/5ff8d770d152682be8269720

response at success

{
    "status": "success",
    "message": "Conversion to archived format is success."
}

response at failure

{
    "status": "error",
    "message": "The file has not been archived, check again."
}

chanage file format to unarchived

http://localhost:8000/api/v1/note/tounArchive/5ff8d770d152682be8269720

response at success

{
    "status": "success",
    "message": "Conversion to unarchived format is success."
}

response at failure

{
    "status": "error",
    "message": "The file has not been unarchived, check again."
}

update content,titile in the file

http://localhost:8000/api/v1/note/update/5ff98240fb6f904188d31542

response at success

{
    "status": "success",
    "message": "Successfully updated."
}

response at failure

{
    "status": "error",
    "message": "Your file is archive file, can not modify"
}

remove files archive or not

http://localhost:8000/api/v1/note/delete/5ff95554f510ce034cabbe0d

response at success

{
    "status": "success",
    "message": "Delete is complete"
}

response at failure

{
    "error": "error",
    "message": "The file has not been deleted."
}

Technologies

node.js , cloud mongo db (atlas)

There are not heavy CPU processing functions. simple REST API. could MongoDB used as a DB.

christcame/personal-note