Skip to content

README.md

Latest commit

 

History

History
39 lines (26 loc) · 1.47 KB

README.md

File metadata and controls

39 lines (26 loc) · 1.47 KB

TaskForge API

API Governance

A minimal FastAPI app demonstrating Delimit API governance.

Every pull request is automatically checked for breaking API changes using the Delimit GitHub Action.

What this repo shows

  1. A working API -- CRUD task management built with FastAPI
  2. An OpenAPI spec -- checked into api/openapi.yaml, generated from the app
  3. Delimit CI -- .github/workflows/api-governance.yml runs on every PR
  4. A breaking change branch -- break-the-api introduces breaking changes so you can see Delimit in action

Try it

pip install -r requirements.txt
uvicorn app.main:app --reload

Open http://localhost:8000/docs to see the interactive API docs.

See Delimit catch breaking changes

Check the open pull request from break-the-api to see the Delimit Action report.

The breaking changes include:

  • Removed DELETE /api/tasks/{task_id} endpoint
  • Renamed assignee field to assigned_to
  • Added required priority field to task creation
  • Changed uptime response type from integer to string

Links