be-api-design

Design REST API contracts with OpenAPI 3.1 schemas and RFC 7807 errors.

Updated Apr 27, 2026
One-click install
npx skills add https://github.com/Conradmaker/copilot-cockpit --skill be-api-design
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: be-api-design
Source: https://github.com/Conradmaker/copilot-cockpit/tree/main/.github/skills/be-api-design
Command: npx skills add https://github.com/Conradmaker/copilot-cockpit --skill be-api-design

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps teams lock REST API contracts early to prevent drift between design and implementation, ensuring consistency across services.

Core Features & Use Cases

  • Resource-first REST patterns and explicit endpoint boundaries (collection, single resource, nested resources)
  • OpenAPI 3.1 as the single source of truth for models, endpoints, request/response schemas, and error catalog
  • Consistent naming, response envelopes, and pagination/filtering strategies to reduce contract drift
  • Use Case: Design a new partner API with versioning, error contracts, and rate-limiting rules

Quick Start

Define the API resource model and endpoint table, then fix the OpenAPI 3.1 starter contract.

Frequently Asked Questions about be-api-design

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

FAQPage Schema
How do I design REST API contracts to prevent drift between design and implementation?

To design REST API contracts and prevent drift, define resource models and endpoint tables first, then lock the OpenAPI 3.1 schema as your single source of truth for request/response schemas and error catalogs.

What is the best way to structure REST API pagination and error handling?

The best way to structure REST API pagination and error handling is to enforce resource-first patterns with consistent naming and use RFC 7807 for standardized error contracts across all services.

How do I use OpenAPI 3.1 as the single source of truth for REST API versioning?

Use OpenAPI 3.1 as the single source of truth for REST API versioning by defining your resource models, endpoint boundaries, and versioning strategies directly within the schema to ensure consistency.

Does this approach support designing nested REST resources and collection boundaries?

Yes, this approach explicitly supports designing nested REST resources and collection boundaries by enforcing resource-first REST patterns that clearly separate collection, single resource, and nested resource endpoints.

When do I need RFC 7807 error contracts for my REST API design?

You need RFC 7807 error contracts for your REST API design when you require a standardized, consistent error catalog across multiple services to prevent contract drift and improve client error handling.

Can I design partner API rate-limiting rules and versioning using contract-first design?

Yes, you can design partner APIs with versioning, rate-limiting rules, and error contracts using a contract-first approach by defining these constraints within your OpenAPI 3.1 starter contract.