skills.rest
rodrigo-altissimo
rodrigo-altissimoCOMMUNITY
Explore all skills by this author →
GitHub

software-engineering-eng-api

Design complete REST, GraphQL, and gRPC API contracts with OpenAPI documentation.

Updated May 6, 2025
Search Tags:#versioning#error handling#api design#rate limiting#openapi#rest#webhook
One-click install
npx skills add https://github.com/rodrigo-altissimo/qiartificial --skill software-engineering-eng-api
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: software-engineering-eng-api
Source: https://github.com/rodrigo-altissimo/qiartificial/tree/main/.claude/skills/software-engineering/eng-api
Command: npx skills add https://github.com/rodrigo-altissimo/qiartificial --skill software-engineering-eng-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It helps teams design reliable, consumer-friendly API contracts so integrations don’t stall on inconsistent endpoints, unclear errors, missing versioning rules, or undocumented behaviors.

Core Features & Use Cases

  • API-first design with concrete endpoint, schema, pagination, error, and documentation requirements.
  • REST/GraphQL/gRPC decisioning to match consumer needs and performance/complexity tradeoffs.
  • Production-grade guardrails for rate limiting, authentication patterns, idempotency, and webhook design.

Quick Start

Use the Gateway to “Design a REST API for order management (CRUD plus webhooks), including cursor pagination, consistent error responses, versioning/deprecation rules, rate limiting tiers, and an OpenAPI-first contract.”

Frequently Asked Questions about software-engineering-eng-api

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

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

To design a REST API with consistent errors and pagination, standardize machine-readable error structures and apply cursor pagination. This Skill outputs API-first contracts enforcing HTTP semantics and OpenAPI readiness.

What is the best way to choose between REST, GraphQL, and gRPC for my API integration?▼

Choosing between REST, GraphQL, and gRPC requires evaluating consumer needs and performance tradeoffs. This Skill provides API style decisioning to match integration scenarios with appropriate protocols.

How do I specify versioning policies and deprecation rules for an OpenAPI contract?▼

Specifying versioning policies for an OpenAPI contract requires establishing clear endpoint lifecycle boundaries. This Skill designs API contracts that include versioning and deprecation rules to prevent integration stalls.

Can I generate webhook event payload designs and rate limiting tiers together?▼

Yes, you can generate webhook payload designs alongside rate limiting tiers. This Skill specifies production-grade guardrails including authentication, idempotency, rate limiting, and webhook structures within one API contract.

When do I need idempotency and authentication patterns in API design?▼

You need idempotency and authentication patterns when building production-grade integrations requiring reliable retries and secure access. This Skill applies these guardrails to ensure reliable, consumer-friendly API contracts.

Related Skills

Explore More Software Engineering Skills→
abhishekmmgnabhishekmmgn

gemini-structured-output

Force Gemini to produce valid JSON or XML outputs using schemas.

Community
Advanced
Dokkabei97Dokkabei97
2

api-first-design

Design API contracts with OpenAPI and GraphQL schemas.

Community
Intermediate
microsoftmicrosoft
242

azure-aigateway

Configures Azure API Management as an AI Gateway with policies for security, caching, and load balancing.

Official
Advanced
copyleftdevcopyleftdev

mendez-async-api

Design event-driven architectures with AsyncAPI specifications and channel-centric contracts.

Community
Intermediate