Skip to content

README.md

Latest commit

 

History

History
116 lines (87 loc) · 2.43 KB

README.md

File metadata and controls

116 lines (87 loc) · 2.43 KB

Notes API

A simple REST API for managing notes, built with FastAPI and SQLite.

Features

  • Create notes
  • List all notes
  • Get a specific note
  • Delete notes
  • Automatic API documentation (Swagger UI)
  • Full test coverage
  • CI/CD with GitHub Actions

Setup

  1. Install dependencies:
pip install -r requirements.txt
  1. Run the API:
uvicorn app.main:app --reload

The API will be available at http://localhost:8000

API Documentation

Once running, visit:

  • Swagger UI: http://localhost:8000/docs
  • ReDoc: http://localhost:8000/redoc

Endpoints

  • GET / - Welcome message
  • POST /notes - Create a new note
  • GET /notes - List all notes
  • GET /notes/{note_id} - Get a specific note
  • DELETE /notes/{note_id} - Delete a note

Testing

Run the test suite:

pytest tests/ -v

CI/CD

GitHub Actions runs tests automatically on:

  • Pushes to master or dev branches
  • Pull requests to master or dev branches

Development

The project structure:

notes-api/
├── app/
│   ├── __init__.py
│   ├── main.py          # FastAPI app and endpoints
│   ├── models.py        # Pydantic models
│   └── database.py      # SQLAlchemy setup
├── tests/
│   ├── __init__.py
│   └── test_api.py      # Test suite
├── requirements.txt
├── .github/
│   └── workflows/
│       └── ci.yml       # GitHub Actions config
└── README.md

Architecture

This project uses C4 model annotations embedded in the source code to generate architecture diagrams.

Viewing Diagrams

Diagrams are automatically generated in CI and uploaded as artifacts.

To generate locally:

# Install c4-literate-python
pip install git+https://github.com/ChristosDev75/c4-literate-python.git

# Generate diagrams
c4-literate tangle . -o docs/architecture/workspace.dsl

# View with Structurizr Lite
docker run -it --rm -p 8080:8080 \
  -v $(pwd):/usr/local/structurizr:Z \
  docker.io/structurizr/lite

# Open http://localhost:8080

Modifying Architecture

Architecture is documented using C4 annotations in Python docstrings. See the c4-literate-python schema for annotation reference.

Example:

"""
@c4-container: API Application
@c4-technology: Python 3.12, FastAPI
@c4-description: REST API providing CRUD operations
"""