Skip to content

API_CURL_EXAMPLES.md

Latest commit

 

History

History
98 lines (76 loc) · 1.87 KB

API_CURL_EXAMPLES.md

File metadata and controls

98 lines (76 loc) · 1.87 KB

Milestone Tracker - API Curl Examples

This document contains all API endpoints with curl commands and their example outputs.

Table of Contents

  1. Public Endpoints (No Auth Required)
  2. Protected Endpoints (Auth Required)
  3. Admin Endpoints

Public Endpoints

1. Get All Pages

curl -s http://localhost:8000/api/pages

2. Get Public Milestones

curl -s http://localhost:8000/api/public/milestones

3. Get Progress (Public)

curl -s http://localhost:8000/api/progress

4. Health Check

curl -s http://localhost:8000/health

Protected Endpoints

Authentication - Login

curl -s -X POST http://localhost:8000/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username": "admin", "password": "your_password"}'

Get Milestones (Authenticated)

curl -s http://localhost:8000/api/milestones \
  -H "Authorization: Bearer YOUR_TOKEN"

Admin Endpoints

Create Page

curl -s -X POST http://localhost:8000/api/pages \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "page_name": "Test Page",
    "page_link": "https://example.com/test",
    "total_questions": 50,
    "completed_questions": 25,
    "subject": "Chemistry",
    "year": 2024,
    "status": "In Progress"
  }'

Update Page

curl -s -X PUT http://localhost:8000/api/pages/PAGE_ID \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "completed_questions": 50,
    "status": "Completed"
  }'

Delete Page

curl -s -X DELETE http://localhost:8000/api/pages/PAGE_ID \
  -H "Authorization: Bearer YOUR_TOKEN"

Run the Live Examples Script

To see all endpoints with live output, run:

./api_curl_live.sh