MemoHub

Overview

This Django API serves as a simple notes taking application, allowing users to create, retrieve, update, and delete notes through a RESTful interface. The API is built using the Tastypie library for Django.

Getting Started

Prerequisites

• Python 3.x
• Django
• Tastypie

Installation

1. Clone the repository to your local machine:

    git clone <repository-url>
   

2. Navigate to the project directory:

    cd <project-directory>
   

3. Install the required dependencies:

    pip install Django && pip install django-tastypie
   

Database Setup

Apply migrations to set up the database:

python manage.py makemigrations
python manage.py migrate

Running the Server

Start the Django development server:

python manage.py runserver

The API will be accessible at http://localhost:8000/api/.\

API Usage Endpoints

• GET /api/note/: Retrieve a list of all notes.

• GET /api/note/{id}/: Retrieve details of a specific note by ID.

• POST /api/note/: Create a new note.
  Request body example in json format:

  { "title": "Note Title", "body": "Note Body" }

• PUT /api/note/{id}/: Update an existing note by ID.
  Request body example (update title and body):

  { "title": "Updated Title", "body": "Updated Body" }

• DELETE /api/note/{id}/: Delete a note by ID.

Authentication

The API currently uses basic authorization.
Ensure that you have the necessary permissions to perform CRUD operations.

Example Usage

Retrieving all notes:

curl http://localhost:8000/api/note/

Creating a new note:

curl -X POST -H "Content-Type: application/json" -d '{"title": "New Note", "body": "This is a new note."}' http://localhost:8000/api/note/

Updating a note:

curl -X PUT -H "Content-Type: application/json" -d '{"title": "Updated Title", "body": "Updated body content."}' http://localhost:8000/api/note/{id}/

Deleting a note:

curl -X DELETE http://localhost:8000/api/note/{id}/

License

This project is licensed under the MIT License.