Notes API

A simple Notes API built with Express.js that supports CRUD operations.

Features

• Create new notes
• Read all notes or a single note by ID
• Update existing notes
• Delete notes
• In-memory storage

Setup

1. Install dependencies:

npm install

2. Start the server:

npm start

3. For development with auto-reload:

npm run dev

API Endpoints

• GET /notes - Get all notes
• GET /notes/:id - Get a single note
• POST /notes - Create a new note
• PUT /notes/:id - Update a note
• DELETE /notes/:id - Delete a note

API Documentation

Access the interactive API documentation using Scalar UI at:

http://localhost:3000/api-reference

The documentation provides:

• Interactive API explorer
• Request/response examples
• Schema validation
• Try-it-out functionality for testing endpoints

Example Usage

Create a new note:

curl -X POST http://localhost:3000/notes \
  -H "Content-Type: application/json" \
  -d '{"title": "My Note", "content": "This is a note"}'