Added REST API with full CRUD + tests

Author: CarloGarcellano

.coverage

@@ -1,37 +1,45 @@
-# Flask Web App Tutorial
+# Flask Web App – REST API Enhancement
 
-## Setup & Installation
+## Project Overview
 
-Make sure you have the latest version of Python installed.
+This project is based on the Flask Web Application Tutorial by Tech With Tim.  
+The original application is a web-based note-taking system with user authentication.
 
-```bash
-git clone <repo-url>
-```
+This project enhances the original application by adding a **REST API feature** that allows full CRUD operations on notes using JSON.
 
-```bash
-pip install -r requirements.txt
-```
+---
 
-## Running The App
+## Original Application Features
 
-```bash
-python main.py
-```
+- User registration and login system
+- Create, view, and delete notes through a web interface
+- SQLite database integration
+- Flask-Login authentication system
 
-## Viewing The App
+---
 
-Go to `http://127.0.0.1:5000`
+## Added Feature: REST API for Notes
 
+A RESTful API was implemented to manage notes without using the frontend.
 
-# 💻 Launch Your Software Development Career Today!  
+### API Endpoints
 
-🎓 **No degree? No problem!** My program equips you with everything you need to break into tech and land an entry-level software development role.  
+| Method | Endpoint | Description |
+|--------|----------|-------------|
+| POST   | /api/notes | Create a new note |
+| GET    | /api/notes | Retrieve all notes |
+| GET    | /api/notes/<id> | Retrieve a single note |
+| PUT    | /api/notes/<id> | Update a note |
+| DELETE | /api/notes/<id> | Delete a note |
 
-🚀 **Why Join?**  
-- 💼 **$70k+ starting salary potential**  
-- 🕐 **Self-paced:** Complete on your own time  
-- 🤑 **Affordable:** Low risk compared to expensive bootcamps or degrees
-- 🎯 **45,000+ job openings** in the market  
+---
 
-👉 **[Start your journey today!](https://techwithtim.net/dev)**  
-No experience needed—just your determination. Future-proof your career and unlock six-figure potential like many of our students have!  
+## Request / Response Format
+
+### Example: Create Note
+
+**Request:**
+```json
+{
+  "data": "My first API note"
+}

README.md

@@ -15,9 +15,11 @@ def create_app():
 
     from .views import views
     from .auth import auth
+    from .api import api
 
     app.register_blueprint(views, url_prefix='/')
     app.register_blueprint(auth, url_prefix='/')
+    app.register_blueprint(api, url_prefix='/')
 
     from .models import User, Note
 
@@ -38,4 +40,4 @@ def load_user(id):
 def create_database(app):
     if not path.exists('website/' + DB_NAME):
         db.create_all(app=app)
-        print('Created Database!')
+        print('Created Database!')

instance/database.db

@@ -0,0 +1,109 @@
+from flask import Blueprint, jsonify, request
+from .models import Note
+from . import db
+
+api = Blueprint('api', __name__)
+
+
+# CREATE NOTE
+@api.route('/api/notes', methods=['POST'])
+def create_note():
+    data = request.get_json()
+
+    if not data or 'data' not in data:
+        return jsonify({
+            "error": "Note content is required"
+        }), 400
+
+    new_note = Note(
+        data=data['data'],
+        user_id=1
+    )
+
+    db.session.add(new_note)
+    db.session.commit()
+
+    return jsonify({
+        "message": "Note created successfully",
+        "id": new_note.id,
+        "data": new_note.data
+    }), 201
+
+
+# READ ALL NOTES
+@api.route('/api/notes', methods=['GET'])
+def get_notes():
+    notes = Note.query.all()
+
+    output = []
+
+    for note in notes:
+        output.append({
+            "id": note.id,
+            "data": note.data,
+            "date": str(note.date)
+        })
+
+    return jsonify(output), 200
+
+
+# READ SINGLENOTE
+@api.route('/api/notes/<int:id>', methods=['GET'])
+def get_note(id):
+    note = Note.query.get(id)
+
+    if not note:
+        return jsonify({
+            "error": "Note not found"
+        }), 404
+
+    return jsonify({
+        "id": note.id,
+        "data": note.data,
+        "date": str(note.date)
+    }), 200
+
+
+# UPDATE NOTE
+@api.route('/api/notes/<int:id>', methods=['PUT'])
+def update_note(id):
+    note = Note.query.get(id)
+
+    if not note:
+        return jsonify({
+            "error": "Note not found"
+        }), 404
+
+    data = request.get_json()
+
+    if not data or 'data' not in data:
+        return jsonify({
+            "error": "Missing note content"
+        }), 400
+
+    note.data = data['data']
+    db.session.commit()
+
+    return jsonify({
+        "message": "Note updated successfully",
+        "id": note.id,
+        "data": note.data
+    }), 200
+
+# DELETE NOTE
+@api.route('/api/notes/<int:id>', methods=['DELETE'])
+def delete_note(id):
+    note = Note.query.get(id)
+
+    if not note:
+        return jsonify({
+            "error": "Note not found"
+        }), 404
+
+    db.session.delete(note)
+    db.session.commit()
+
+    return jsonify({
+        "message": "Note deleted successfully",
+        "id": id
+    }), 200

website/__init__.py

@@ -0,0 +1,115 @@
+import pytest
+from website import create_app, db
+from website.models import Note
+
+
+@pytest.fixture
+def app():
+    app = create_app()
+    app.config['TESTING'] = True
+    app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///:memory:'
+
+    with app.app_context():
+        db.create_all()
+        yield app
+        db.drop_all()
+
+
+@pytest.fixture
+def client(app):
+    return app.test_client()
+
+
+# -------------------------
+# CREATE
+# -------------------------
+def test_create_note(client):
+    response = client.post('/api/notes', json={
+        "data": "pytest note"
+    })
+
+    assert response.status_code == 201
+
+    data = response.get_json()
+    assert "id" in data
+    assert data["data"] == "pytest note"
+
+
+# -------------------------
+# READ ALL
+# -------------------------
+def test_get_all_notes(client):
+    client.post('/api/notes', json={"data": "note 1"})
+    client.post('/api/notes', json={"data": "note 2"})
+
+    response = client.get('/api/notes')
+
+    assert response.status_code == 200
+
+    data = response.get_json()
+    assert isinstance(data, list)
+    assert len(data) == 2
+
+
+# -------------------------
+# READ SINGLE
+# -------------------------
+def test_get_single_note(client):
+    create = client.post('/api/notes', json={"data": "single note"})
+    note_id = create.get_json()["id"]
+
+    response = client.get(f'/api/notes/{note_id}')
+
+    assert response.status_code == 200
+
+    data = response.get_json()
+    assert data["data"] == "single note"
+
+
+def test_get_single_note_not_found(client):
+    response = client.get('/api/notes/999')
+
+    assert response.status_code == 404
+
+
+# -------------------------
+# UPDATE
+# -------------------------
+def test_update_note(client):
+    create = client.post('/api/notes', json={"data": "old note"})
+    note_id = create.get_json()["id"]
+
+    response = client.put(f'/api/notes/{note_id}', json={
+        "data": "updated note"
+    })
+
+    assert response.status_code == 200
+
+    data = response.get_json()
+    assert data["data"] == "updated note"
+
+
+def test_update_note_not_found(client):
+    response = client.put('/api/notes/999', json={
+        "data": "nothing"
+    })
+
+    assert response.status_code == 404
+
+
+# -------------------------
+# DELETE
+# -------------------------
+def test_delete_note(client):
+    create = client.post('/api/notes', json={"data": "to delete"})
+    note_id = create.get_json()["id"]
+
+    response = client.delete(f'/api/notes/{note_id}')
+
+    assert response.status_code == 200
+
+
+def test_delete_note_not_found(client):
+    response = client.delete('/api/notes/999')
+
+    assert response.status_code == 404