skills.rest
brunolimaff-jpg
brunolimaff-jpgCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design resilient API contracts with OpenAPI 3.1, cursor pagination, and RFC 7807 errors.

Updated Feb 19, 2026
Search Tags:#api design#openapi#rest#graphql#pagination#grpc#rfc 7807
One-click install
npx skills add https://github.com/brunolimaff-jpg/NOVO-APP --skill api-design-brunolimaff-jpg
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/brunolimaff-jpg/NOVO-APP/tree/main/.agents/skills/archive/2026-04-curation/api-design
Command: npx skills add https://github.com/brunolimaff-jpg/NOVO-APP --skill api-design-brunolimaff-jpg

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill helps you avoid brittle, confusing API contracts by guiding you to make consistent endpoint design, schemas, pagination, versioning, and error responses that clients can integrate with reliably.

Core Features & Use Cases

  • API architecture decisions: Choose the right approach for REST, GraphQL, or gRPC based on client, performance, caching, and streaming needs.
  • OpenAPI-first contract authoring: Write and structure OpenAPI 3.1 specs with reusable components, consistent request/response schemas, and security definitions.
  • Production-ready integration patterns: Implement cursor-based pagination, version APIs safely, and standardize errors using RFC 7807 (problem+json).

Quick Start

Ask: Design a REST API for a v1 endpoint with cursor pagination, JWT auth, and an OpenAPI 3.1 spec that returns RFC 7807 problem+json errors.

Frequently Asked Questions about api-design

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

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

To design a REST API with cursor pagination and RFC 7807 errors, structure your endpoints to return problem+json for failures and implement cursor-based pagination to ensure safe, consistent client integration without breaking changes.

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

Choosing between REST, GraphQL, and gRPC depends on your client integration needs, performance caching requirements, and streaming demands. Evaluate each protocol's semantics to reduce integration friction and select the most resilient contract approach.

How do I structure an OpenAPI 3.1 specification with reusable components and JWT auth?▼

Structure an OpenAPI 3.1 specification by defining reusable components, consistent request/response schemas, and security definitions for JWT auth to ensure robust API contracts and safe version evolution.

When do I need cursor-based pagination instead of offset pagination in API design?▼

You need cursor-based pagination in API design when handling large or frequently changing datasets to ensure stable results, consistent request modeling, and safe evolution without breaking existing client integrations.

How do I standardize API error responses using RFC 7807 problem+json?▼

Standardize API error responses using RFC 7807 problem+json by structuring error formats with consistent HTTP semantics, ensuring clients receive detailed, machine-readable failure information that reduces integration friction.

Related Skills

Explore More Software Engineering Skills→
claudcherejiclaudchereji

legal-advisor

Draft contracts and identify compliance gaps in technology law.

Community
Advanced
ccfccf

openapi-spec-generation

Generate and validate OpenAPI 3.1 specifications from design or code sources.

Community
Advanced
invowkinvowk

invowk-schema

Enforce consistent schemas for invkfile.cue and invkmod module definitions.

Official
Advanced
fabioc-alohafabioc-aloha
1

API Documentation Skill

Scaffold technical documentation projects with templates for API endpoints and guides.

Community
Intermediate