fastmock-api 0.1.0__tar.gz

fastmock_api-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,59 @@
+name: CI Pipeline
+
+on:
+  push:
+    branches: [ "main" ]
+    tags: [ "v*.*.*" ]
+  pull_request:
+    branches: [ "main" ]
+  workflow_dispatch:
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+
+    - name: Install Dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install hatch
+        pip install -e ".[dev]"
+
+    - name: Run Ruff (Linter & Formatter)
+      run: |
+        ruff check .
+        
+    - name: Run Pytest
+      run: |
+        pytest tests/ -v
+
+  publish:
+    name: Publish to PyPI
+    needs: build-and-test
+    if: github.event_name == 'workflow_dispatch' || startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v4
+      
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+        
+    - name: Build package
+      run: |
+        python -m pip install build
+        python -m build
+        
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}

fastmock_api-0.1.0/.gitignore

@@ -0,0 +1,19 @@
+__pycache__/
+*.py[cod]
+*$py.class
+.pytest_cache/
+.coverage
+htmlcov/
+.venv/
+venv/
+env/
+.env
+.mypy_cache/
+.ruff_cache/
+build/
+dist/
+*.egg-info/
+
+# Local mock specifications
+openapi.yaml
+openapi.json

fastmock_api-0.1.0/Dockerfile

@@ -0,0 +1,19 @@
+FROM python:3.12-slim
+
+WORKDIR /app
+
+# Отключаем создание байт-кода и буферизацию
+ENV PYTHONDONTWRITEBYTECODE=1
+ENV PYTHONUNBUFFERED=1
+
+# Установка зависимостей (используем pip, так как pyproject.toml поддерживает PEP 621)
+COPY pyproject.toml README.md ./
+COPY src/ ./src/
+
+RUN pip install --no-cache-dir -e .
+
+# Ожидается, что пользователь примонтирует openapi.yaml в /app/openapi.yaml
+# или загрузит его через API
+EXPOSE 8000
+
+CMD ["fastmock"]

fastmock_api-0.1.0/PKG-INFO

@@ -0,0 +1,71 @@
+Metadata-Version: 2.5
+Name: fastmock-api
+Version: 0.1.0
+Summary: A lightweight, local Mock server on FastAPI for frontend and mobile teams.
+Requires-Python: >=3.12
+Requires-Dist: faker>=19.0.0
+Requires-Dist: fastapi>=0.100.0
+Requires-Dist: jsonref>=1.1.0
+Requires-Dist: pydantic-settings>=2.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: python-multipart>=0.0.9
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: typer>=0.9.0
+Requires-Dist: uvicorn>=0.23.0
+Requires-Dist: websockets>=12.0
+Provides-Extra: dev
+Requires-Dist: httpx; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest-asyncio; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<div align="right">
+  <a href="README_RU.md">🇷🇺 Русский</a> | <b>🇬🇧 English</b>
+</div>
+
+# ⚡ FastMock API Engine
+
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![FastAPI](https://img.shields.io/badge/FastAPI-0.100+-009688.svg?logo=fastapi)](https://fastapi.tiangolo.com)
+[![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?logo=docker&logoColor=white)](https://www.docker.com/)
+[![Build Status](https://github.com/Artem-SPb/fastmock/actions/workflows/ci.yml/badge.svg)](https://github.com/Artem-SPb/fastmock/actions)
+
+**FastMock** is a lightweight, local Mock server built on FastAPI. It's designed for frontend and mobile developers who need a reliable, realistic REST API instantly, without waiting for the backend team.
+
+![FastMock Preview](docs/assets/preview.png) *(You can place the generated image here)*
+
+## 🚀 Features at a glance
+1. **Dynamic OpenAPI Ingestion**: Drop your `openapi.yaml` in the folder or upload via Admin API. The endpoints are generated on the fly.
+2. **Realistic Payload Generation**: Automatically generates realistic data (names, emails, UUIDs, dates) based on JSON Schema types using `Faker`.
+3. **In-Memory CRUD**: Remembers what you `POST` and returns it on `GET`.
+4. **Chaos Engineering**: Simulate slow 3G networks or random server crashes (HTTP 500, 503) globally or per-request using HTTP headers.
+
+## 📖 Detailed Documentation
+For deep-dive instructions, check the full usage guide:
+👉 **[Read the Full Documentation (English)](docs/USAGE_EN.md)**
+
+## 🛠 Quick Start (Docker)
+
+The easiest way to run FastMock is via Docker.
+
+1. Clone the repository:
+```bash
+git clone https://github.com/Artem-SPb/fastmock.git
+cd fastmock
+```
+2. Place your `openapi.yaml` in the root directory (optional).
+3. Run the container:
+```bash
+docker compose up
+```
+4. Open **http://127.0.0.1:8000/docs** in your browser!
+
+## 👨‍💻 Author
+**Artem-SPb** 
+- GitHub: [@Artem-SPb](https://github.com/Artem-SPb)
+
+Created as a portfolio project showcasing modern Python architecture, FastAPI ecosystem, and Developer Experience (DX) best practices.
+
+*Feel free to star ⭐ this repository if you found it helpful!*

fastmock_api-0.1.0/README.md

@@ -0,0 +1,48 @@
+<div align="right">
+  <a href="README_RU.md">🇷🇺 Русский</a> | <b>🇬🇧 English</b>
+</div>
+
+# ⚡ FastMock API Engine
+
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![FastAPI](https://img.shields.io/badge/FastAPI-0.100+-009688.svg?logo=fastapi)](https://fastapi.tiangolo.com)
+[![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?logo=docker&logoColor=white)](https://www.docker.com/)
+[![Build Status](https://github.com/Artem-SPb/fastmock/actions/workflows/ci.yml/badge.svg)](https://github.com/Artem-SPb/fastmock/actions)
+
+**FastMock** is a lightweight, local Mock server built on FastAPI. It's designed for frontend and mobile developers who need a reliable, realistic REST API instantly, without waiting for the backend team.
+
+![FastMock Preview](docs/assets/preview.png) *(You can place the generated image here)*
+
+## 🚀 Features at a glance
+1. **Dynamic OpenAPI Ingestion**: Drop your `openapi.yaml` in the folder or upload via Admin API. The endpoints are generated on the fly.
+2. **Realistic Payload Generation**: Automatically generates realistic data (names, emails, UUIDs, dates) based on JSON Schema types using `Faker`.
+3. **In-Memory CRUD**: Remembers what you `POST` and returns it on `GET`.
+4. **Chaos Engineering**: Simulate slow 3G networks or random server crashes (HTTP 500, 503) globally or per-request using HTTP headers.
+
+## 📖 Detailed Documentation
+For deep-dive instructions, check the full usage guide:
+👉 **[Read the Full Documentation (English)](docs/USAGE_EN.md)**
+
+## 🛠 Quick Start (Docker)
+
+The easiest way to run FastMock is via Docker.
+
+1. Clone the repository:
+```bash
+git clone https://github.com/Artem-SPb/fastmock.git
+cd fastmock
+```
+2. Place your `openapi.yaml` in the root directory (optional).
+3. Run the container:
+```bash
+docker compose up
+```
+4. Open **http://127.0.0.1:8000/docs** in your browser!
+
+## 👨‍💻 Author
+**Artem-SPb** 
+- GitHub: [@Artem-SPb](https://github.com/Artem-SPb)
+
+Created as a portfolio project showcasing modern Python architecture, FastAPI ecosystem, and Developer Experience (DX) best practices.
+
+*Feel free to star ⭐ this repository if you found it helpful!*

fastmock_api-0.1.0/README_RU.md

@@ -0,0 +1,48 @@
+<div align="right">
+  <b>🇷🇺 Русский</b> | <a href="README.md">🇬🇧 English</a>
+</div>
+
+# ⚡ FastMock API Engine
+
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![FastAPI](https://img.shields.io/badge/FastAPI-0.100+-009688.svg?logo=fastapi)](https://fastapi.tiangolo.com)
+[![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?logo=docker&logoColor=white)](https://www.docker.com/)
+[![Build Status](https://github.com/Artem-SPb/fastmock/actions/workflows/ci.yml/badge.svg)](https://github.com/Artem-SPb/fastmock/actions)
+
+**FastMock** — это легковесный, локальный Mock-сервер на базе FastAPI. Он создан для фронтенд- и мобильных разработчиков, которым нужен работающий, реалистичный REST API "здесь и сейчас", без ожидания бэкенд-команды.
+
+![FastMock Preview](docs/assets/preview.png) *(Здесь будет ваше превью)*
+
+## 🚀 Ключевые возможности
+1. **Динамическая загрузка OpenAPI**: Просто положите `openapi.yaml` в папку с проектом или загрузите через Admin API, и эндпоинты сгенерируются на лету.
+2. **Реалистичная генерация данных**: Автоматически создает правдоподобные данные (имена, email, UUID, даты) на основе типов в JSON Schema с помощью библиотеки `Faker`.
+3. **In-Memory CRUD**: Запоминает данные, которые вы отправляете через `POST`, и возвращает их при `GET` запросах.
+4. **Chaos Engineering**: Симулируйте медленные 3G-сети или случайные падения сервера (HTTP 500, 503) глобально или для конкретных запросов через HTTP-заголовки.
+
+## 📖 Подробная документация
+Для глубокого погружения и примеров изучите полную инструкцию:
+👉 **[Читать полную документацию (на русском)](docs/USAGE_RU.md)**
+
+## 🛠 Быстрый старт (Docker)
+
+Самый простой способ запустить FastMock — использовать Docker.
+
+1. Склонируйте репозиторий:
+```bash
+git clone https://github.com/Artem-SPb/fastmock.git
+cd fastmock
+```
+2. Положите вашу спецификацию `openapi.yaml` в корень проекта (необязательно).
+3. Запустите контейнер:
+```bash
+docker compose up
+```
+4. Откройте **http://127.0.0.1:8000/docs** в вашем браузере!
+
+## 👨‍💻 Автор
+**Artem-SPb** 
+- GitHub: [@Artem-SPb](https://github.com/Artem-SPb)
+
+Создано в качестве портфолио-проекта, демонстрирующего современную архитектуру на Python, работу с экосистемой FastAPI и фокус на Developer Experience (DX).
+
+*Если проект оказался полезным, не забудьте поставить звездочку ⭐!*

fastmock_api-0.1.0/docker-compose.yml

@@ -0,0 +1,13 @@
+version: '3.8'
+
+services:
+  fastmock:
+    build: .
+    ports:
+      - "8000:8000"
+    volumes:
+      # Монтируем файл спецификации (если он есть локально)
+      # - ./openapi.yaml:/app/openapi.yaml
+      - ./src:/app/src
+    environment:
+      - DEBUG=1

fastmock_api-0.1.0/docs/USAGE_EN.md

@@ -0,0 +1,67 @@
+# How to use FastMock (Guide for Frontend & Mobile Developers)
+
+If the backend isn't ready yet, but you need to build UI, render lists, handle network errors, or plot real-time charts — **FastMock** will save your time. You don't need to know Python or databases to run it.
+
+---
+
+## 🛠 Step 1: Start the server (Takes 1 minute)
+
+You don't need to configure environments. Everything works via Docker.
+
+1. Ensure you have [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed.
+2. Download this project (or run `git clone`).
+3. Open a terminal in the project folder and type:
+   ```bash
+   docker compose up
+   ```
+4. Done! The server is running. Open the dashboard in your browser: **http://127.0.0.1:8000/docs**
+
+---
+
+## 📄 Step 2: Add API Contracts (Swagger)
+
+FastMock doesn't know in advance which endpoints your app needs. You have to provide a specification (OpenAPI / Swagger file).
+
+1. Ask your backend developer for the `openapi.yaml` file (or write a simple one yourself).
+2. Go to the dashboard (http://127.0.0.1:8000/docs).
+3. Find the green **`POST /_admin/specs`** button, click *Try it out*, select your file, and hit *Execute*.
+4. **Magic:** The server instantly generates all the endpoints defined in the file!
+
+> 💡 **Quick Start:** There is an `openapi.example.yaml` file in the project folder. Just copy it, rename it to `openapi.yaml`, and restart the server. You'll instantly get working `/users` and `/products` endpoints.
+
+---
+
+## 📱 Step 3: Connect your application
+
+Now, simply change the base URL in your iOS/Android/Web app's code to `http://127.0.0.1:8000`.
+
+### 🧠 Smart Data Generation
+Make a `GET /users` request from your app. You won't get an empty response. FastMock will generate realistic JSON! If a field is named `email`, it returns a real random email; if it's `id`, it generates a UUID.
+
+### 💾 Data Persistence (Forms)
+Want to test a profile creation form?
+1. Send a `POST /users` from your app with any JSON (e.g., `{"name": "John"}`).
+2. Make a `GET /users` request. John will appear in the list!
+The data is saved. *(Note: if you start the server with the `--persist db.json` flag, data is saved to a file that you can edit right in your text editor!)*
+
+---
+
+## 🌩 Step 4: Testing Errors (Chaos Engineering)
+
+How will your app behave if the user has a poor 3G connection in the subway, or the backend crashes with a 500 error?
+You don't need to unplug your ethernet cable! Just add Headers to your requests from the app:
+
+* `X-Mock-Delay: 2000` — The server will "think" for exactly 2 seconds before responding. Check your loading spinners!
+* `X-Mock-Status: 500` — The server will forcibly return a 500 Server Error. Test your error alerts and fallback screens!
+
+---
+
+## ⏱ Step 5: WebSockets Testing (Real-time)
+
+If you're building a chat or a crypto chart, you need WebSockets. FastMock can simulate those too!
+
+Connect your app to `ws://127.0.0.1:8000/ws/chat`.
+1. **Echo:** Send any text, and it comes right back.
+2. **Data Stream:** Send a special JSON `{"action": "stream", "interval": 1}`, and the server will infinitely stream new generated data to you every second! (Send `{"action": "stop"}` to pause it).
+
+Happy coding! 🚀

fastmock_api-0.1.0/docs/USAGE_RU.md

@@ -0,0 +1,67 @@
+# Как использовать FastMock (Гайд для Фронтенд и Мобайл разработчиков)
+
+Если бэкенд еще не готов, а тебе нужно делать UI, выводить списки, обрабатывать ошибки сети или графики — **FastMock** спасет твое время. Тебе не нужно знать Python или базы данных, чтобы запустить его.
+
+---
+
+## 🛠 Шаг 1: Запуск сервера (Занимает 1 минуту)
+
+Тебе не нужно настраивать окружение. Всё работает через Docker.
+
+1. Убедись, что у тебя установлен [Docker Desktop](https://www.docker.com/products/docker-desktop/).
+2. Скачай этот проект (или сделай `git clone`).
+3. Открой терминал в папке проекта и напиши:
+   ```bash
+   docker compose up
+   ```
+4. Готово! Сервер запущен. Открой в браузере панель управления: **http://127.0.0.1:8000/docs**
+
+---
+
+## 📄 Шаг 2: Добавляем API контракты (Swagger)
+
+FastMock не знает заранее, какие эндпоинты нужны твоему приложению. Ему нужно дать спецификацию (OpenAPI / Swagger файл). 
+
+1. Попроси у бэкенд-разработчика файл `openapi.yaml` (или напиши простой сам).
+2. Зайди в панель управления (http://127.0.0.1:8000/docs).
+3. Найди зеленую кнопку **`POST /_admin/specs`**, нажми *Try it out*, выбери свой файл и нажми *Execute*.
+4. **Магия:** Сервер моментально сгенерировал все эндпоинты, которые были в файле!
+
+> 💡 **Быстрый старт:** В папке проекта уже лежит файл `openapi.example.yaml`. Просто скопируй его, назови `openapi.yaml` и перезапусти сервер. У тебя сразу появятся эндпоинты `/users` и `/products`.
+
+---
+
+## 📱 Шаг 3: Подключаем твое приложение
+
+Теперь в коде твоего iOS/Android/Web приложения просто поменяй базовый URL на `http://127.0.0.1:8000`.
+
+### 🧠 Умная генерация данных
+Сделай запрос `GET /users` из приложения. Тебе не вернется пустота. FastMock сам сгенерирует реалистичный JSON! Если поле называется `email` — он вернет реальный случайный email, если `id` — сгенерирует UUID.
+
+### 💾 Сохранение данных (Формы)
+Хочешь протестировать форму создания профиля?
+1. Отправь из приложения `POST /users` с любым JSON (например, `{"name": "Иван"}`).
+2. Сделай `GET /users`. Иван появится в списке!
+Данные сохраняются. *(Примечание: если запустить сервер с флагом `--persist db.json`, то данные сохранятся в файл, который можно редактировать прямо в блокноте!)*
+
+---
+
+## 🌩 Шаг 4: Тестирование ошибок (Chaos Engineering)
+
+Как твое приложение поведет себя, если у пользователя плохой интернет в метро (Edge/3G) или бэкенд упал с 500 ошибкой?
+Тебе не нужно выдергивать кабель интернета! Просто добавь заголовки (Headers) к своим запросам из приложения:
+
+* `X-Mock-Delay: 2000` — Сервер будет "думать" ровно 2 секунды перед ответом. Проверь свои лоадеры (спиннеры).
+* `X-Mock-Status: 500` — Сервер принудительно вернет 500 ошибку сервера. Проверь алерты и экраны ошибок!
+
+---
+
+## ⏱ Шаг 5: Тестирование WebSockets (Real-time)
+
+Если ты делаешь чат или график биржи, тебе нужны вебсокеты. FastMock умеет симулировать и их!
+
+Подключись из приложения к `ws://127.0.0.1:8000/ws/chat`.
+1. **Эхо:** Отправь любой текст, и он вернется обратно.
+2. **Поток данных (Стриминг):** Отправь специальный JSON `{"action": "stream", "interval": 1}`, и сервер начнет каждую секунду бесконечно присылать тебе новые сгенерированные данные! (Отправь `{"action": "stop"}`, чтобы остановить).
+
+Удачной разработки! 🚀

fastmock_api-0.1.0/openapi.example.yaml

@@ -0,0 +1,120 @@
+openapi: 3.0.3
+info:
+  title: Sample E-Commerce API
+  description: Тестовая спецификация для проверки возможностей FastMock API Engine.
+  version: 1.0.0
+servers:
+  - url: http://localhost:8000
+paths:
+  /users:
+    get:
+      summary: Получить список пользователей
+      responses:
+        '200':
+          description: Успешный ответ
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/User'
+    post:
+      summary: Создать нового пользователя
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UserCreate'
+      responses:
+        '201':
+          description: Пользователь создан
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/User'
+  /users/{id}:
+    get:
+      summary: Получить пользователя по ID
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+            format: uuid
+      responses:
+        '200':
+          description: Успешный ответ
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/User'
+  /products:
+    get:
+      summary: Получить список товаров
+      responses:
+        '200':
+          description: Успешный ответ
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Product'
+
+components:
+  schemas:
+    User:
+      type: object
+      properties:
+        id:
+          type: string
+          format: uuid
+        first_name:
+          type: string
+          description: Имя пользователя
+        last_name:
+          type: string
+          description: Фамилия пользователя
+        email:
+          type: string
+          format: email
+        phone:
+          type: string
+        created_at:
+          type: string
+          format: date-time
+      required:
+        - id
+        - first_name
+        - email
+
+    UserCreate:
+      type: object
+      properties:
+        first_name:
+          type: string
+        last_name:
+          type: string
+        email:
+          type: string
+          format: email
+      required:
+        - first_name
+        - email
+
+    Product:
+      type: object
+      properties:
+        id:
+          type: string
+          format: uuid
+        name:
+          type: string
+        price:
+          type: number
+          example: 99.99
+        in_stock:
+          type: boolean
+          example: true

fastmock_api-0.1.0/pyproject.toml

@@ -0,0 +1,49 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "fastmock-api"
+version = "0.1.0"
+description = "A lightweight, local Mock server on FastAPI for frontend and mobile teams."
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "fastapi>=0.100.0",
+    "uvicorn>=0.23.0",
+    "pydantic>=2.0.0",
+    "pydantic-settings>=2.0.0",
+    "faker>=19.0.0",
+    "pyyaml>=6.0",
+    "jsonref>=1.1.0",
+    "python-multipart>=0.0.9",
+    "typer>=0.9.0",
+    "websockets>=12.0"
+]
+
+[project.scripts]
+fastmock = "fastmock.cli:app"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-asyncio",
+    "httpx",
+    "ruff",
+    "mypy"
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "B", "UP", "SIM", "RUF", "BLE", "ASYNC"]
+ignore = ["B008", "BLE001", "S110", "SIM102", "ASYNC230", "RUF059", "RUF002", "RUF003", "E501", "RUF001", "UP015", "ASYNC240", "E402"]
+
+[tool.mypy]
+strict = true
+ignore_missing_imports = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/fastmock"]