api-designer

Define API contracts with endpoints, schemas, validation, and error handling.

Updated Apr 19, 2026
One-click install
npx skills add https://github.com/saranskumar/anti-slop --skill api-designer-saranskumar
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/saranskumar/anti-slop/tree/main/skills/api-designer
Command: npx skills add https://github.com/saranskumar/anti-slop --skill api-designer-saranskumar

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Aligns frontend and backend teams by defining precise API contracts upfront, reducing back-and-forth and rework during implementation.

Core Features & Use Cases

  • Define endpoints, request/response shapes, validation rules, and error handling for a clear integration contract.
  • Include authentication, pagination, filtering, and webhook patterns to cover common backend interactions.
  • Use to guide API design for new features, migrations, or external integrations with well-defined contracts.

Quick Start

Draft the API contracts for the new payments feature and capture the endpoints, request/response schemas, and auth requirements.

Frequently Asked Questions about api-designer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I design API contracts before implementation to align frontend and backend teams?

Designing API contracts upfront defines precise endpoints, request/response shapes, validation, and error handling to align frontend and backend teams. This reduces integration back-and-forth and rework by establishing explicit data schemas and clear integration expectations before coding begins.

What is the best way to define endpoints and request/response schemas for a new feature?

The best way to define endpoints and request/response schemas is to draft minimal viable contracts that explicitly capture data shapes, validation rules, and error handling. This ensures all integration expectations for new features or migrations are documented clearly.

Can I include auth, pagination, and webhook patterns in my backend API design?

Yes, you can include auth, pagination, filtering, and webhook patterns in your backend API design. Defining these common interactions within your API contracts ensures comprehensive coverage for standard service-to-service or client-to-backend integrations.

Does defining API contracts work for BFF design scenarios and external integrations?

Defining API contracts works effectively for BFF design scenarios and external integrations. It provides well-defined contracts that specify explicit data schemas and clear integration expectations, satisfying requirements for both backend migrations and frontend-facing interfaces.

How do I specify validation rules and error handling in web API contracts?

Specify validation rules and error handling in web API contracts by documenting explicit constraints for request payloads and standardized error response shapes. This establishes a clear integration contract that prevents unexpected data formatting issues during implementation.