Communitygithub.com

jeffallan/api-designer

Use ao projetar APIs REST ou GraphQL, criar especificações OpenAPI ou planejar arquitetura de API. Acione para modelagem de recursos, estratégias de versionamento, padrões de paginação, padrões de tratamento de erros.

O que é api-designer?

Este skill é projetado para desenvolvedores e arquitetos de software que estão projetando APIs REST ou GraphQL, criando especificações OpenAPI, ou planejando a arquitetura geral de uma API. Ele fornece assistência especializada em tarefas fundamentais como modelagem de recursos, definição de estratégias de versionamento (por exemplo, versionamento por URI, cabeçalho ou query parameter), implementação de padrões de paginação (como cursor-based ou page-based) e estabelecimento de padrões robustos de tratamento de erros. O skill é útil para garantir consistência e boas práticas em todo o ciclo de vida do design da API, suportando plataformas como Claude Code, Cursor e Codex. Ele funciona interpretando as intenções do usuário e fornecendo orientações e exemplos práticos com base na documentação SKILL.md. Ao acionar este skill durante sessões de design, o desenvolvedor pode acelerar a tomada de decisões arquiteturais e evitar armadilhas comuns.

Funciona com~Claude Code~Codex CLI~Cursor
Part ofDesign & UI
npx skills add https://github.com/jeffallan/claude-skills/tree/main/skills/api-designer
Ver original→Navegar por todas as habilidades

Perguntar na sua IA favorita

Abre um novo chat com esta habilidade de agente já pré-carregada.

OpenAIChatGPTClaudeClaudeGeminiGeminiGrokGrokPerplexityPerplexityDeepSeekDeepSeek

Documentação

O que api-designer faz?

Use ao projetar APIs REST ou GraphQL, criar especificações OpenAPI ou planejar arquitetura de API. Acione para modelagem de recursos, estratégias de versionamento, padrões de paginação, padrões de tratamento de erros.

Visão Geral

Este skill auxilia no design de APIs de forma estruturada e consistente, cobrindo desde a modelagem inicial de recursos até a definição de estratégias de versionamento, paginação e tratamento de erros.

Plataformas Suportadas

  • Claude Code
  • Cursor
  • Codex

Como Usar

Para ativar o skill, use a palavra-chave api-designer ou invoque-o durante sessões de design de API. Exemplo:

Use o api-designer para modelar os recursos de uma API REST de e-commerce.

Funcionalidades Principais

Modelagem de Recursos

  • Definição de modelos de dados
  • Relacionamentos entre recursos (um-para-um, um-para-muitos, muitos-para-muitos)
  • Práticas recomendadas para nomenclatura (substantivos no plural, kebab-case)

Versionamento de API

  • Versionamento por URI (/v1/recursos)
  • Versionamento por cabeçalho (Accept: application/vnd.api+json;version=1)
  • Versionamento por query parameter (?version=1)

Padrões de Paginação

  • Paginação baseada em cursor (recomendada para alta performance)
  • Paginação baseada em página (page e per_page)
  • Paginação baseada em offset (offset e limit)

Tratamento de Erros

  • Padrão de resposta de erro consistente (exemplo: { "error": { "code": "NOT_FOUND", "message": "Recurso não encontrado" } })
  • Códigos de status HTTP apropriados (200, 201, 400, 401, 403, 404, 409, 422, 500)
  • Mensagens de erro descritivas e localizadas

Exemplo de Uso

Usuário: "Projete uma API para gerenciar tarefas (todos)."
Assistente: (com api-designer ativado)
  - Recurso: `/tasks`
  - Versionamento: `/v1/tasks`
  - Paginação: cursor-based (id)
  - Erros: padrão JSON com código e mensagem

Boas Práticas

  • Sempre usar HTTPS em produção
  • Documentar a API com OpenAPI 3.0+
  • Versionar desde a primeira versão
  • Usar paginação para listas grandes
  • Fornecer respostas de erro consistentes

Licença

Este skill é fornecido sob a licença MIT. Consulte o repositório original para mais detalhes.

Individual skills in this repo

This repo contains 20 individual skills — each has its own dedicated page.

jeffallan/angular-architect

Generates Angular 17+ standalone components, configures advanced routing with lazy loading and guards, implements NgRx state management, applies RxJS patterns, and optimizes bundle performance. Use when building Angular 17+ applications with standalone components or signals, setting up NgRx stores, establishing RxJS reactive patterns, performance tuning, or writing Angular tests for enterprise apps.

jeffallan/architecture-designer

Use when designing new high-level system architecture, reviewing existing designs, or making architectural decisions. Invoke to create architecture diagrams, write Architecture Decision Records (ADRs), evaluate technology trade-offs, design component interactions, and plan for scalability. Use for system design, architecture review, microservices structuring, ADR authoring, scalability planning, and infrastructure pattern selection — distinct from code-level design patterns or database-only design tasks.

jeffallan/atlassian-mcp

Integrates with Atlassian products to manage project tracking and documentation via MCP protocol. Use when querying Jira issues with JQL filters, creating and updating tickets with custom fields, searching or editing Confluence pages with CQL, managing sprints and backlogs, setting up MCP server authentication, syncing documentation, or debugging Atlassian API integrations.

jeffallan/chaos-engineer

Designs chaos experiments, creates failure injection frameworks, and facilitates game day exercises for distributed systems — producing runbooks, experiment manifests, rollback procedures, and post-mortem templates. Use when designing chaos experiments, implementing failure injection frameworks, or conducting game day exercises. Invoke for chaos experiments, resilience testing, blast radius control, game days, antifragile systems, fault injection, Chaos Monkey, Litmus Chaos.

jeffallan/cli-developer

Use when building CLI tools, implementing argument parsing, or adding interactive prompts. Invoke for parsing flags and subcommands, displaying progress bars and spinners, generating bash/zsh/fish completion scripts, CLI design, shell completions, and cross-platform terminal applications using commander, click, typer, or cobra.

jeffallan/cloud-architect

Designs cloud architectures, creates migration plans, generates cost optimization recommendations, and produces disaster recovery strategies across AWS, Azure, and GCP. Use when designing cloud architectures, planning migrations, or optimizing multi-cloud deployments. Invoke for Well-Architected Framework, cost optimization, disaster recovery, landing zones, security architecture, serverless design.

jeffallan/code-documenter

Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides.

jeffallan/code-reviewer

Analyzes code diffs and files to identify bugs, security vulnerabilities (SQL injection, XSS, insecure deserialization), code smells, N+1 queries, naming issues, and architectural concerns, then produces a structured review report with prioritized, actionable feedback. Use when reviewing pull requests, conducting code quality audits, identifying refactoring opportunities, or checking for security issues. Invoke for PR reviews, code quality checks, refactoring suggestions, review code, code quality. Complements specialized skills (security-reviewer, test-master) by providing broad-scope review across correctness, performance, maintainability, and test coverage in a single pass.

jeffallan/cpp-pro

Writes, optimizes, and debugs C++ applications using modern C++20/23 features, template metaprogramming, and high-performance systems techniques. Use when building or refactoring C++ code requiring concepts, ranges, coroutines, SIMD optimization, or careful memory management — or when addressing performance bottlenecks, concurrency issues, and build system configuration with CMake.

jeffallan/csharp-developer

Use when building C# applications with .NET 8+, ASP.NET Core APIs, or Blazor web apps. Builds REST APIs using minimal or controller-based routing, configures database access with Entity Framework Core, implements async patterns and cancellation, structures applications with CQRS via MediatR, and scaffolds Blazor components with state management. Invoke for C#, .NET, ASP.NET Core, Blazor, Entity Framework, EF Core, Minimal API, MAUI, SignalR.

jeffallan/database-optimizer

Optimizes database queries and improves performance across PostgreSQL and MySQL systems. Use when investigating slow queries, analyzing execution plans, or optimizing database performance. Invoke for index design, query rewrites, configuration tuning, partitioning strategies, lock contention resolution.

jeffallan/debugging-wizard

Parses error messages, traces execution flow through stack traces, correlates log entries to identify failure points, and applies systematic hypothesis-driven methodology to isolate and resolve bugs. Use when investigating errors, analyzing stack traces, finding root causes of unexpected behavior, troubleshooting crashes, or performing log analysis, error investigation, or root cause analysis.

jeffallan/devops-engineer

Creates Dockerfiles, configures CI/CD pipelines, writes Kubernetes manifests, and generates Terraform/Pulumi infrastructure templates. Handles deployment automation, GitOps configuration, incident response runbooks, and internal developer platform tooling. Use when setting up CI/CD pipelines, containerizing applications, managing infrastructure as code, deploying to Kubernetes clusters, configuring cloud platforms, automating releases, or responding to production incidents. Invoke for pipelines, Docker, Kubernetes, GitOps, Terraform, GitHub Actions, on-call, or platform engineering.

jeffallan/django-expert

Use when building Django web applications or REST APIs with Django REST Framework. Invoke when working with settings.py, models.py, manage.py, or any Django project file. Creates Django models with proper indexes, optimizes ORM queries using select_related/prefetch_related, builds DRF serializers and viewsets, and configures JWT authentication. Trigger terms: Django, DRF, Django REST Framework, Django ORM, Django model, serializer, viewset, Python web.

jeffallan/dotnet-core-expert

Use when building .NET 8 applications with minimal APIs, clean architecture, or cloud-native microservices. Invoke for Entity Framework Core, CQRS with MediatR, JWT authentication, AOT compilation.

jeffallan/embedded-systems

Use when developing firmware for microcontrollers, implementing RTOS applications, or optimizing power consumption. Invoke for STM32, ESP32, FreeRTOS, bare-metal, power optimization, real-time systems, configure peripherals, write interrupt handlers, implement DMA transfers, debug timing issues.

jeffallan/fastapi-expert

Use when building high-performance async Python APIs with FastAPI and Pydantic V2. Invoke to create REST endpoints, define Pydantic models, implement authentication flows, set up async SQLAlchemy database operations, add JWT authentication, build WebSocket endpoints, or generate OpenAPI documentation. Trigger terms: FastAPI, Pydantic, async Python, Python API, REST API Python, SQLAlchemy async, JWT authentication, OpenAPI, Swagger Python.

jeffallan/feature-forge

Conducts structured requirements workshops to produce feature specifications, user stories, EARS-format functional requirements, acceptance criteria, and implementation checklists. Use when defining new features, gathering requirements, or writing specifications. Invoke for feature definition, requirements gathering, user stories, EARS format specs, PRDs, acceptance criteria, or requirement matrices.

jeffallan/fine-tuning-expert

Use when fine-tuning LLMs, training custom models, or adapting foundation models for specific tasks. Invoke for configuring LoRA/QLoRA adapters, preparing JSONL training datasets, setting hyperparameters for fine-tuning runs, adapter training, transfer learning, finetuning with Hugging Face PEFT, OpenAI fine-tuning, instruction tuning, RLHF, DPO, or quantizing and deploying fine-tuned models. Trigger terms include: LoRA, QLoRA, PEFT, finetuning, fine-tuning, adapter tuning, LLM training, model training, custom model.

jeffallan/flutter-expert

Use when building cross-platform applications with Flutter 3+ and Dart. Invoke for widget development, Riverpod/Bloc state management, GoRouter navigation, platform-specific implementations, performance optimization.

Habilidades Relacionadas

steipete/sag

ElevenLabs text-to-speech with mac-style say UX.

community

steipete/oracle

Oracle CLI second-model review/debug/refactor/design with selected files, dry-run token checks, API or browser engine.

community

steipete/peekaboo

Capture and automate macOS UI with the Peekaboo CLI.

community

mattpocock/design-an-interface

Generate multiple radically different interface designs for a module using parallel sub-agents. Use when user wants to design an API, explore interface options, compare module shapes, or mentions "design it twice".

community

mattpocock/prototype

Build a throwaway prototype to flesh out a design — a runnable terminal app for state/business-logic questions, or several radically different UI variations toggleable from one route.

community

mattpocock/grill-me

Interview the user relentlessly about a plan or design until reaching shared understanding, resolving each branch of the decision tree. Use when user wants to stress-test a plan, get grilled on their design, or mentions "grill me".

community