Trilha de estudo
Trilha Design & Arquitetura de APIs: tudo o que estudar, tópico por tópico
Avaliacao abrangente de design de APIs cobrindo fundamentos REST, modelagem de recursos, autenticacao e seguranca, documentacao com OpenAPI, estrategias de versionamento, padroes avancados (GraphQL, gRPC, webhooks), caching, API gateways e governanca.
Resposta curta
Para aprender Design & Arquitetura de APIs, percorra 6 módulos e 22 tópicos na ordem em que um apoia o próximo. Comece por Fundamentos REST e siga para Principios de Design de API e Autenticacao & Seguranca. Use o mapa como checklist, ou meça seu nível e estude só o que falta.
O que você vai estudar
Os tópicos estão agrupados por módulo. Abra um para ver os objetivos e os conceitos-chave.
1 · Fundamentos REST4 tópicos
Metodos HTTP
Semantica de GET, POST, PUT, PATCH, DELETE, garantias de idempotencia, metodos seguros vs inseguros, HEAD e OPTIONS, diretrizes de selecao de metodos
Objetivos
- Selecionar o metodo HTTP correto para cada operacao CRUD
- Explicar idempotencia e suas implicacoes para design de APIs
Conceitos-chave
- GET para recuperacao
- POST para criacao
- PUT para substituicao completa
- PATCH para atualizacao parcial
- DELETE para remocao
- idempotencia
- metodos seguros
- HEAD e OPTIONS
Codigos de Status HTTP
1xx informacional, 2xx sucesso, 3xx redirecionamento, 4xx erros do cliente, 5xx erros do servidor, escolha de codigos apropriados, anti-padroes comuns
Objetivos
- Escolher o codigo de status correto para respostas de API
- Distinguir entre 401 Unauthorized e 403 Forbidden
Conceitos-chave
- 200 OK
- 201 Created
- 204 No Content
- 400 Bad Request
- 401 vs 403
- 404 Not Found
- 409 Conflict
- 429 Too Many Requests
Design de URLs
Convencoes de nomenclatura de recursos, plural vs singular, caminhos hierarquicos, parametros de query, parametros de caminho, melhores praticas de estrutura de URI
Objetivos
- Projetar URLs de API limpas e consistentes
- Decidir entre parametros de caminho e de query
Conceitos-chave
- substantivos plurais para colecoes
- recursos aninhados
- parametros de caminho
- parametros de query
- kebab-case vs snake_case
- evitar verbos em URLs
- profundidade de hierarquia de recursos
- limites de tamanho de URI
Formatos de Requisicao & Resposta
Estrutura JSON, negociacao de conteudo, cabecalhos Accept e Content-Type, padroes de envelope, convencoes de nomes de campos, tipos de dados em JSON
Objetivos
- Estruturar corpos de requisicao e resposta JSON consistentes
- Aplicar cabecalhos de negociacao de conteudo corretamente
Conceitos-chave
- JSON como formato padrao
- cabecalho Content-Type
- cabecalho Accept
- campos camelCase vs snake_case
- datas ISO 8601
- padrao envelope
- tratamento de null
- consistencia de tipos de dados
2 · Principios de Design de API4 tópicos
Modelagem de Recursos
Identificacao de recursos a partir de modelos de dominio, sub-recursos, relacionamentos entre recursos, recursos compostos, endpoints de acao para operacoes nao-CRUD
Objetivos
- Modelar recursos de API a partir de conceitos do dominio de negocios
- Projetar endpoints de acao para operacoes que nao mapeiam para CRUD
Conceitos-chave
- identificacao de recursos orientada ao dominio
- sub-recursos
- relacionamentos entre recursos
- recursos compostos
- endpoints de acao
- recursos singleton
- granularidade de recursos
- evitar pensamento apenas CRUD
Paginacao & Filtragem
Paginacao baseada em offset, paginacao baseada em cursor, paginacao baseada em pagina, parametros de query para filtragem, ordenacao, selecao de campos, endpoints de busca
Objetivos
- Escolher a estrategia de paginacao correta para diferentes conjuntos de dados
- Projetar parametros de query consistentes para filtragem e ordenacao
Conceitos-chave
- paginacao offset/limit
- paginacao baseada em cursor
- paginacao page/per_page
- parametros de ordenacao
- sintaxe de filtro via query
- selecao de campos (sparse fieldsets)
- endpoints de busca
- metadados de paginacao
Tratamento de Erros
Formato de resposta de erro, RFC 7807 Problem Details, codigos de erro, erros de validacao, localizacao de mensagens de erro, agregacao de erros
Objetivos
- Projetar um formato consistente de resposta de erro seguindo RFC 7807
- Retornar mensagens de erro acionaveis sem expor detalhes internos
Conceitos-chave
- RFC 7807 Problem Details
- taxonomia de codigos de erro
- arrays de erros de validacao
- erros em nivel de campo
- internacionalizacao de mensagens de erro
- exclusao de stack trace
- agregacao de erros
- orientacao de retry em erros
HATEOAS & Hipermidia
Hypermidia como Motor do Estado da Aplicacao, relacoes de links, formato HAL, links JSON:API, descobribilidade, Modelo de Maturidade de Richardson
Objetivos
- Explicar os niveis do Modelo de Maturidade de Richardson
- Adicionar links de hipermidia nas respostas de API para descobribilidade
Conceitos-chave
- principio HATEOAS
- relacoes de link (self, next, prev)
- formato HAL
- links JSON:API
- Modelo de Maturidade de Richardson
- descobribilidade de API
- controles de hipermidia
- templates de link
3 · Autenticacao & Seguranca4 tópicos
Mecanismos de Autenticacao
Chaves de API, fluxos OAuth 2.0, estrutura e validacao JWT, bearer tokens, autenticacao basica, sessao vs autenticacao por token, OIDC
Objetivos
- Escolher o mecanismo de autenticacao apropriado para diferentes consumidores de API
- Explicar o fluxo OAuth 2.0 authorization code de ponta a ponta
Conceitos-chave
- chaves de API
- OAuth 2.0 fluxo authorization code
- OAuth 2.0 client credentials
- estrutura JWT (header, payload, assinatura)
- bearer tokens
- fluxo de refresh de token
- OpenID Connect
- autenticacao basica
Padroes de Autorizacao
Controle de acesso baseado em papeis (RBAC), controle de acesso baseado em atributos (ABAC), escopos, permissoes, autorizacao em nivel de recurso, engines de politica
Objetivos
- Projetar um modelo de autorizacao que suporte multi-tenancy
- Distinguir entre autenticacao e autorizacao no design de APIs
Conceitos-chave
- RBAC
- ABAC
- escopos OAuth 2.0
- permissoes granulares
- autorizacao em nivel de recurso
- engines de politica (OPA)
- escopo de chave de API
- autorizacao multi-tenant
Melhores Praticas de Seguranca de API
OWASP API Security Top 10, validacao de entrada, CORS, TLS, prevencao de injecao, exposicao de dados sensiveis, mass assignment
Objetivos
- Aplicar mitigacoes do OWASP API Security Top 10
- Configurar politicas CORS corretamente para consumidores de API
Conceitos-chave
- OWASP API Security Top 10
- validacao de entrada
- configuracao CORS
- aplicacao de TLS/HTTPS
- prevencao de injecao
- dados sensiveis em respostas
- protecao contra mass assignment
- cabecalhos de seguranca
Rate Limiting & Throttling
Algoritmo token bucket, janela deslizante, janela fixa, cabecalhos de rate limit, gerenciamento de cotas, tratamento de burst, limites por cliente, respostas 429
Objetivos
- Projetar uma estrategia de rate limiting com cabecalhos apropriados
- Comparar algoritmos token bucket e janela deslizante
Conceitos-chave
- algoritmo token bucket
- contador de janela deslizante
- contador de janela fixa
- cabecalhos X-RateLimit
- cabecalho Retry-After
- cotas por cliente
- permissao de burst
- rate limits em camadas
4 · Documentacao & Versionamento3 tópicos
Especificacao OpenAPI
Estrutura OpenAPI 3.x, paths, schemas, componentes, definicoes de requisicao/resposta, geracao de codigo, Swagger UI, design API-first
Objetivos
- Escrever uma especificacao OpenAPI para uma API RESTful
- Aplicar design API-first comecando pela especificacao
Conceitos-chave
- estrutura OpenAPI 3.x
- paths e operacoes
- definicoes de schema
- componentes e reusabilidade
- definicoes de corpo de requisicao
- definicoes de resposta
- geracao de codigo a partir da spec
- fluxo de design API-first
Versionamento de API
Versionamento por caminho de URL, versionamento por cabecalho, versionamento por parametro de query, versionamento por negociacao de conteudo, versionamento semantico para APIs, encerramento de versao
Objetivos
- Escolher uma estrategia de versionamento de API e justificar os trade-offs
- Identificar mudancas breaking vs non-breaking em uma API
Conceitos-chave
- versionamento por caminho de URL (/v1/)
- versionamento por cabecalho (Accept)
- versionamento por parametro de query
- negociacao de conteudo
- versionamento semantico
- mudancas breaking vs non-breaking
- coexistencia de versoes
- cabecalho sunset
Changelog & Depreciacao
Gerenciamento de changelog de API, politicas de depreciacao, cabecalhos sunset, guias de migracao, comunicacao com consumidores, estrategias de compatibilidade retroativa
Objetivos
- Projetar uma politica de depreciacao com cronogramas e comunicacao claros
- Gerenciar evolucao de API mantendo compatibilidade retroativa
Conceitos-chave
- formatos de changelog
- avisos de depreciacao
- cabecalho Sunset (RFC 8594)
- guias de migracao
- notificacao de consumidores
- compatibilidade retroativa
- periodos de graca
- analytics de uso para depreciacao
5 · Padroes Avancados5 tópicos
APIs GraphQL
Linguagem de definicao de schema, queries, mutations, subscriptions, resolvers, problema N+1, DataLoader, federation, trade-offs REST vs GraphQL
Objetivos
- Projetar um schema GraphQL com definicoes de tipo adequadas
- Comparar trade-offs de REST e GraphQL para diferentes casos de uso
Conceitos-chave
- linguagem de definicao de schema (SDL)
- queries e mutations
- subscriptions
- resolvers
- problema N+1
- padrao DataLoader
- federation
- trade-offs REST vs GraphQL
gRPC & Protocol Buffers
Schema Protocol Buffers, definicoes de servico, RPCs unarios e streaming, gRPC vs REST, streaming bidirecional, modelo de erros, gRPC-Web
Objetivos
- Definir mensagens protobuf e servicos gRPC
- Escolher entre REST, GraphQL e gRPC para diferentes cenarios
Conceitos-chave
- Protocol Buffers (protobuf)
- definicoes de servico
- RPC unario
- streaming do servidor
- streaming do cliente
- streaming bidirecional
- modelo de erros gRPC
- gRPC-Web para navegadores
Webhooks & APIs Orientadas a Eventos
Design de webhooks, estrutura de payload de eventos, garantias de entrega, politicas de retry, verificacao de assinatura, schemas de eventos, SSE, APIs WebSocket
Objetivos
- Projetar um sistema de webhooks com entrega confiavel e verificacao de assinatura
- Comparar webhooks, SSE e WebSocket para comunicacao em tempo real de API
Conceitos-chave
- registro de webhooks
- design de payload de eventos
- garantias de entrega
- retry com backoff exponencial
- verificacao de assinatura HMAC
- versionamento de schema de eventos
- Server-Sent Events (SSE)
- APIs WebSocket
Caching & Desempenho
Cabecalhos de caching HTTP, ETags, requisicoes condicionais, integracao com CDN, estrategias de invalidacao de cache, compressao de resposta de API, pool de conexoes
Objetivos
- Implementar caching HTTP com cabecalhos adequados e requisicoes condicionais
- Projetar uma estrategia de invalidacao de cache para APIs
Conceitos-chave
- cabecalho Cache-Control
- ETag e If-None-Match
- Last-Modified e If-Modified-Since
- camadas de cache CDN
- estrategias de invalidacao de cache
- compressao de resposta (gzip, br)
- pool de conexoes
- 304 Not Modified
API Gateways
Padroes de gateway, roteamento de requisicoes, balanceamento de carga, transformacao de requisicoes, agregacao, circuit breaker, integracao com service mesh
Objetivos
- Projetar uma camada de API gateway com roteamento, rate limiting e autenticacao
- Comparar abordagens de API gateway e service mesh
Conceitos-chave
- padrao API gateway
- roteamento de requisicoes
- balanceamento de carga
- transformacao de requisicao/resposta
- agregacao de APIs (BFF)
- circuit breaker
- integracao com service mesh
- gateway vs service mesh
6 · Governanca de APIs2 tópicos
Padroes & Guias de Estilo de API
Guias de estilo de API, aplicacao de convencoes de nomenclatura, regras de linting, processos de revisao de design, catalogo de APIs, portal do desenvolvedor, geracao de SDK
Objetivos
- Criar um guia de estilo de API que garanta consistencia entre equipes
- Configurar linting automatizado de API com Spectral ou ferramentas similares
Conceitos-chave
- autoria de guia de estilo de API
- regras de linting spectral
- processo de revisao de design
- catalogo e registro de APIs
- portal do desenvolvedor
- geracao automatica de SDK
- biblioteca de padroes de design de API
- aplicacao de consistencia
Gerenciamento de Ciclo de Vida de API
API-as-a-product, estagios de ciclo de vida, modelo de maturidade de API, estrategia de plataforma, monetizacao, ecossistema de parceiros, metricas e KPIs de API
Objetivos
- Definir KPIs de API e medir o sucesso do programa de API
- Projetar uma estrategia de plataforma de API com monetizacao e ecossistema de parceiros
Conceitos-chave
- mentalidade API-as-a-product
- estagios de ciclo de vida de API
- modelo de maturidade de API
- estrategia de plataforma
- modelos de monetizacao de API
- APIs de parceiros e ecossistema
- KPIs e metricas de API
- gerenciamento de programa de API
Níveis: Júnior, Pleno, Sênior e Especialista
Explique com suas palavras
Corrigido por IA · sem cadastro · 1 perguntaSem alternativas para chutar: você escreve, a IA corrige com a rubrica do tópico e diz em que nível sua resposta está.
Já estuda Design & Arquitetura de APIs?
A avaliação mede tópico por tópico, e o plano pula o que você já sabe.
Aberto para ler. A conta só é necessária para ser medido.
Perguntas frequentes
Por onde começar a estudar Design & Arquitetura de APIs?
Comece por Fundamentos REST: Metodos HTTP, Codigos de Status HTTP e Design de URLs. O mapa ordena os tópicos pelo que depende de quê, então cada um prepara o seguinte.
Quanto tempo leva uma avaliação completa de Design & Arquitetura de APIs?
Uma avaliação completa desta trilha leva cerca de 45 minutos. O tempo de estudo depende de onde você começa; o diagnóstico mostra quais tópicos você pode pular.
Preciso de conta para usar esta página?
Não. O mapa, os objetivos e os conceitos-chave são abertos. A conta só é necessária para ser medido, ver seu gap por tópico e receber um plano.