Skip to content

IT Top Academy Journal API Documentation

IT Top Academy has no public API documentation. This project fills the gap — covering 34 endpoints across 11 feature groups.

Quick Start

  1. Open Swagger UI — Swagger UI works immediately, no token needed: the worker returns anonymized mock data
  2. Try logging in — click "Try it out" on /auth/login. The worker (a Cloudflare proxy) forwards the request to the real API and returns a live JWT
  3. Get a token — if you need access to real data, see Authentication
  4. Read the docs — pick an API section for detailed endpoint reference with field-level descriptions

What the Project Does

  • Collects real API responses via authenticated requests
  • Validates structure with Pydantic — when the API changes, the pipeline fails and opens a GitHub Issue
  • Anonymizes data with Faker — no real names, IDs, or dates in the public repository
  • Generates openapi.json and publishes Swagger UI + text documentation

CI Pipeline

Steps executed on each run (nightly cron or manual trigger):

tests → collect → validate → anonymize → publish → worker
                                          ↘ mkdocs
  1. tests — project unit tests
  2. collect — requests to the real API, response collection
  3. validate — Pydantic schema validation; on failure — GitHub Issue
  4. anonymize — sensitive data replacement via Faker
  5. publish — generate openapi.json and deploy Swagger UI to GitHub Pages
  6. worker — build and deploy the Cloudflare Worker (mock server + proxy)
  7. mkdocs — build and deploy text documentation to GitHub Pages
Page Content
Authentication Getting a token, headers, Authorize button
Swagger UI Interactive API explorer
Mock Server How the Cloudflare Worker works
Glossary Terms and concepts used in this documentation
API Reference Detailed endpoint documentation by feature group