Skip to content

README.md

Latest commit

 

History

History
91 lines (68 loc) · 2.02 KB

README.md

File metadata and controls

91 lines (68 loc) · 2.02 KB

python-server

Flask app that calls external APIs — useful for demonstrating proxymock record, mock, and replay.

Endpoints

  • GET /healthz — health check
  • GET /models — top downloaded models from Hugging Face
  • GET /models/<org>/<model> — details for a specific model (e.g. /models/deepseek-ai/DeepSeek-R1)
  • GET /llm/models — LLM model catalog and pricing from OpenRouter
  • GET /nasa — NASA astronomy picture of the day
  • GET /events — recent GitHub events for the Speedscale org

Architecture

graph LR
    Client -->|:5001| flask-app
    flask-app --> HuggingFace["huggingface.co"]
    flask-app --> OpenRouter["openrouter.ai"]
    flask-app --> NASA["api.nasa.gov"]
    flask-app --> GitHub["api.github.com"]
Loading

Quick start

make install
make local
# Running on http://0.0.0.0:5001

./test-all.sh

proxymock workflow

Record

Capture all outbound API calls while using the app:

graph LR
    Client -->|:4143| proxymock-in
    proxymock-in --> flask-app
    flask-app --> proxymock-out[":4140"]
    proxymock-out --> HuggingFace
    proxymock-out --> OpenRouter
    proxymock-out --> NASA
    proxymock-out --> GitHub
    proxymock-out -.->|saved to disk| files["proxymock/demo/"]
Loading 
make capture
# hit endpoints in another terminal
./test-all.sh localhost:4143
# ctrl-c to stop

Mock

Run the app with recorded responses instead of real APIs:

graph LR
    Client -->|:5001| flask-app
    flask-app -->|:4140| proxymock-mock
    proxymock-mock -.->|reads from| files["proxymock/demo/"]
Loading 
make mock

./test-all.sh              # served from recorded data, no real API calls

Replay

Turn recorded traffic into a load test:

make local &
make replay

# concurrent users
proxymock replay --in proxymock/demo --test-against http://localhost:5001 --vus 10

# CI gate
proxymock replay --in proxymock/demo --test-against http://localhost:5001 \
  --fail-if "requests.failed!=0"