Giter Club home page Giter Club logo

chtr_note_taking_apis_assessment's Introduction

Note Taking APIs

This repository contains the API endpoints for managing notes.

Requirements

Python 3.x
Django
Django REST Framework
Installation\

Clone the repository:

git clone <repository_url>

Create a virtual environment

python -m venv venv

Active the env

.\venv\Script\active.ps1

or for Mac

souce venv/bin/activate

Install dependencies:

pip install -r requirements.txt

Run migrations:

python manage.py migrate

Usage

Start the Django development server:

python manage.py runserver

Access the API endpoints using a REST client like Postman or cURL.

API Endpoints

GET /notes/{note_id}/: Retrieves a single note object that has id=note_id.
PUT /notes/{note_id}/: Updates a single note object that has id=note_id.
GET /notes/?title=example: Retrieves a list of all notes. Optionally, accepts query parameters for filtering notes by title.
POST /notes/: Creates a new note.

Required and optional Rarameters

title : required for POST/optional for PUT body : required for POST/optional for PUT

chtr_note_taking_apis_assessment's People

Contributors

ambar-06 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.