agentskills.codes
CA

campusway-api-contract-regression

by md-muntasir-shihabSource

CampusWay API contract and regression workflow for Express TypeScript endpoints. Use when: API response changed, field mismatch, frontend integration broke, schema drift, endpoint refactor, release regression checks.

Install

mkdir -p .claude/skills/campusway-api-contract-regression && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/15164" && unzip -o skill.zip -d .claude/skills/campusway-api-contract-regression && rm skill.zip

Installs to .claude/skills/campusway-api-contract-regression

Activation

This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.

CampusWay API contract and regression workflow for Express TypeScript endpoints. Use when: API response changed, field mismatch, frontend integration broke, schema drift, endpoint refactor, release regression checks.
216 chars✓ has a “when” trigger

About this skill

CampusWay API Contract Regression

Outcome

Keep backend responses and frontend expectations aligned while reducing endpoint regressions.

When To Use

  • API payload shape changes.
  • Frontend breaks after backend refactor.
  • New fields are added or renamed.
  • Release candidate needs API safety validation.

Procedure

  1. Define contract scope:
  • endpoint path and method
  • request fields
  • response fields and status codes
  1. Confirm current backend implementation for that endpoint.
  2. Compare frontend usage path and required fields.
  3. Apply minimal compatibility changes:
  • preserve old fields when safe
  • add additive fields before removing legacy fields
  1. Run verification:
  • cd backend && npm run build
  • targeted backend tests for affected module
  • cd frontend && npm run build
  • cd frontend && npm run e2e:smoke -- e2e/public-smoke.spec.ts
  1. Record explicit contract delta:
  • added fields
  • removed fields
  • status code changes

Decision Points

  • If breaking change is unavoidable, require staged rollout note and frontend update in same PR.
  • If contract is used by multiple clients, keep backward-compatible fallback window.

Quality Checks

  • No runtime undefined-field errors in frontend.
  • Backend returns stable status codes and validation errors.
  • Contract changes are documented in related API docs.

References In Workspace

  • API_CONTRACT_SUBSCRIPTION.md
  • HOME_API_CONTRACT.md
  • NEWS_API_CONTRACT.md
  • backend/API_DOCUMENTATION.md

More by md-muntasir-shihab

View all by md-muntasir-shihab →

campusway-frontend-quality

md-muntasir-shihab

CampusWay frontend quality workflow for Vite React and Tailwind with optional Next.js surface. Use when: improve UI, refactor components, fix layout, optimize bundle, enforce design consistency, prepare frontend PR.

00

Search skills

Search the agent skills registry