Guia para Design de APIs

• Introdução
  • O que são as APIs?
  • Alguns exemplos de APIs
  • Especificações e protocolos de APIs
    • SOAP
    • REST
• API First ou Design First
• HTTP: Verbos
  • GET
  • HEAD
  • OPTIONS
  • TRACE
  • PUT
  • DELETE
  • POST
  • PATCH
  • CONNECT
• URLs
• Parâmetros
  • Pesquisa avançada
  • Ordenação
  • Paginação
• HTTP: Status Code
  • 1xx - Informativo
  • 2xx - Sucesso
  • 3xx - Redirecionamento
  • 4xx - Erro do cliente
  • 5xx - Erro do servidor
• Contratos
• Tratamento de erros
• Versionamento
  • Versionamento pela URL
  • Cabeçalho customizado
  • Cabeçalho Accept
• Segurança
• Logs
• Documentação
  • O que deve ter na minha documentação?
  • Entendendo melhor Swagger e OpenAPI
  • Ferramentas para documentação

---

Projeto idealizado por: franciellyferreira

Entre em contato: e-mail

Ajude a manter o projeto atualizado: repositório no Github

Licença: acessar