skills.rest
vibbs
vibbsCOMMUNITY
Explore all skills by this author →
GitHub

api-contract-designer

Design REST and GraphQL API contracts with RFC7807 error formats.

6|1|Updated Feb 25, 2026
Search Tags:#error handling#api design#openapi#graphql#rest api#pagination#contract design
One-click install
npx skills add https://github.com/vibbs/company-os --skill api-contract-designer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-contract-designer
Source: https://github.com/vibbs/company-os/tree/main/.claude/skills/api-contract-designer
Command: npx skills add https://github.com/vibbs/company-os --skill api-contract-designer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and scripts (resource) components.

What problem does it solve?

This Skill ensures that API contracts are designed consistently, adhering to company standards for error handling, pagination, authentication, and internationalization, thereby improving interoperability and maintainability.

Core Features & Use Cases

  • Standardized API Design: Creates RESTful or GraphQL API contracts that follow predefined conventions.
  • Consistent Error Handling: Implements RFC7807 compliant error formats.
  • Pagination Strategies: Supports both cursor-based and offset-based pagination.
  • Authentication & Authorization: Defines security requirements for endpoints.
  • Use Case: When developing a new microservice, use this Skill to generate a comprehensive OpenAPI specification for its endpoints, ensuring it aligns with the company's API guidelines.

Quick Start

Use the api-contract-designer skill to design a new API endpoint for retrieving user profiles.

Frequently Asked Questions about api-contract-designer

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

FAQPage Schema
How do I design a REST API contract with consistent error handling and pagination?▼

Designing a REST API contract with consistent error handling involves applying RFC7807 compliant error formats and selecting either cursor-based or offset-based pagination. This ensures endpoints align with company standards for interoperability.

What is the best way to create an OpenAPI specification for a new microservice?▼

Creating an OpenAPI specification for a new microservice is best handled by generating a comprehensive contract that defines security requirements, pagination strategies, and internationalization, ensuring the endpoints align with predefined company API guidelines.

Can I use this to design GraphQL API contracts or is it only for REST APIs?▼

Yes, you can design GraphQL API contracts as well as REST APIs. The design process supports both architectures, applying consistent standards for authentication, authorization, error handling, and internationalization across your service interfaces.

How does RFC7807 improve API error handling in contract design?▼

RFC7807 improves API error handling by providing a standardized, machine-readable error format. Implementing RFC7807 in your API contract design ensures consistent error responses across endpoints, which improves interoperability and maintainability.

Do I need to configure company API standards before designing service interfaces?▼

Yes, adherence to company configuration for API standards is required. Configuring these standards beforehand ensures the generated REST or GraphQL contracts properly implement the correct authentication, pagination, and internationalization requirements.

Related Skills

Explore More Software Engineering Skills→
michaelsvanbeekmichaelsvanbeek
1

api-design

Define REST API design patterns and contract standards for endpoints and OpenAPI documentation.

Community
Advanced
Dokkabei97Dokkabei97
2

api-first-design

Design API contracts with OpenAPI and GraphQL schemas.

Community
Intermediate
AojdevStudioAojdevStudio
317

route-tester

Validate cookie-based JWT authenticated routes across API endpoints and environments.

Community
Intermediate
TheBushidoCollectiveTheBushidoCollective
187

graphql-schema-design

Design GraphQL schemas with type systems, SDL patterns, pagination, and versioning.

Official
Advanced