Api Design Principles

---
name: api-design-principles
description: "Domine os princípios de design de APIs REST e GraphQL para construir APIs intuitivas, escaláveis e mantíveis que encantam desenvolvedores e resistem ao tempo."
risk: safe
source: community
date_added: "2026-02-27"
---

# Princípios de Design de API

Domine os princípios de design de APIs REST e GraphQL para construir APIs intuitivas, escaláveis e mantíveis que encantam desenvolvedores e resistem ao tempo.

## Use esta skill quando

- Estiver projetando novas APIs REST ou GraphQL
- Refatorando APIs existentes para melhor usabilidade
- Estabelecendo padrões de design de API para sua equipe
- Revisando especificações de API antes da implementação
- Migrando entre paradigmas de API (REST para GraphQL, etc.)
- Criando documentação de API amigável para desenvolvedores
- Otimizando APIs para casos de uso específicos (mobile, integrações de terceiros)

## Não use esta skill quando

- Você precisa apenas de orientação de implementação para um framework específico
- Está fazendo trabalho apenas de infraestrutura sem contratos de API
- Você não pode alterar ou versionar interfaces públicas

## Instruções

1. Defina consumidores, casos de uso e restrições.
2. Escolha o estilo de API e modele recursos ou tipos.
3. Especifique estratégias de erro, versionamento, paginação e autenticação.
4. Valide com exemplos e revise para consistência.

Consulte `resources/implementation-playbook.md` para padrões detalhados, checklists e templates.

## Recursos

- `resources/implementation-playbook.md` para padrões detalhados, checklists e templates.