Projeto de APIs

O que pensar para APIs públicas,
[micros]serviços e SPAS

Transcript

1. Projetos de APIs O que pensar para APIs públicas, [micros]serviços e SPAS Celso Crivelaro @celsocrivelaro http://crivelaro.me
2. $whoami
3. Tech Lead @ Professor @
4. Motivação
8. Um caso curioso ...
9. Portal Usuário O que achávamos que deveria ser: Sistema Portal Administrativo API HTTP Serviria aos Portais Serviria como API Externa
10. Portal Usuário O que achávamos que deveria ser: Sistema Portal Administrativo API HTTP Serviria aos Portais Serviria como API Externa Inseguro Dificulta Mudanças
11. POST: Inserção em lote com Payloads Grandes API Externa API com foco em sistema Schemas em formatos diferentes: JSON e XML
12. Muitas mudanças nas telas API Single Page Application API com foco em usuário
13. Segundo caso curioso ...
14. Recebimento Core Processamento Transformação API HTTP Envio aos Provedores Recebimento Processamento Transformação Envio aos Provedores
15. ~ 8 milhões de consultas ao dia API Serviço Consulta de informações para saldo e transformações Performance era um problema
16. Lições Aprendida
18. Tenha APIs diferentes para propósitos diferentes
19. Decisões arquiteturais têm impacto no negócio
20. Documente primeiro
21. Conheça seu público
22. Financeiro e Sistemas Tradicionais Público Geral Devs Iniciantes Equipe Interna Equipe Terceira
23. Tipos de Integração Comuns
24. Muito fácil de fazer -> Script, Não tem o overhead web Integração por Arquivo Integração por FTP, Upload de Arquivo e S3 Arquivo Posicional ou CSV
25. Bom para API Externa / Microsserviços Integração via WebService REST ou SOAP Schema: XML, JSON, Binários
28. Desacopla a transmissão da mensagem Integração via Broker Regras de Envio e distribuição Schema: XML, JSON, Binários
30. Segurança
31. Só se expor se necessário
32. Portal Usuário Sistema 1 Portal Administrativo Sistema 2 Sistema 3 WebService
33. Portal Usuário Sistema 1 Portal Administrativo Sistema 2 Sistema 3 Interfaces abertas para ataque Camada na Internet WebService
34. Portal Usuário Sistema 1 Portal Administrativo Sistema 2 Sistema 3 Serviço API Usuário Camada na Internet Rede Fechada WebService
35. Sempre por HTTPS
36. Autenticação
37. Foco em usuário SPA OAuth, Usuário/Senha Sessão Tokens (grandes) Serviços / API Externa Gestão de invalidação Login baseado no Protocolo Broken
38. Sempre use autenticação, mesmo para serviço interno
39. Tarifação Operacional Problema: Pirata Operacional
40. Tarifação Operacional Problema: Pirata Operacional Rede Interna
41. Volume
42. Consulta -> Cache
43. Disponibilidade Tolerância ao Particionamento Consistência Efeito Colateral do Cache
44. Inserção
45. Bom para itens pequenos e baixo volume WebService - Integração Externa / [Micros]serviços Problemático quando o payload é grande Imediatamente ponha em um processamento assíncrono
46. Validação de Schema Validação de Dados Problema: Payload Grande Inserção
47. Sistema 2 Sistema 1 Sistema 3 Sistema 4 Problema: Broadcast
48. Fácil para inserção Broker - Microsserviços Desacopla mensagem do transmissão Problema: Manter mais uma infraestrutura
49. Sistema 1 Sistema 2 Problema: Lote
50. Pode-se enviar MBs ou GBs de um único arquivo Arquivos - Microsserviços Usar AWS S3 ou mesmo SFTP Quando não há pressa
51. Versionamento
52. Breaking Changes
53. Remover um endpoint / fila / diretório Breaking Changes Adicionar novo campo obrigatório Remover ou Alterar campo ou tipo
54. Como versionar
55. Nome do Recurso. Ex: HTTP POST#/v1/usuarios Versionamento Meta Informação: Ex: HTTP Header X-Api-Version: 1 Não usar no payload
56. Como avisar a todos que API tem nova mudança Gestão de Mudança Manter as 2 versões por um tempo Plano de desligamento da versão anterior
57. Schema
58. Enviar dados conhecidos pela App originadora [Micros]Serviços / WebService Metadados Endereço de Callback
59. Documentação
60. 1o Passo: Permite fazer o design Documentação Permite que 2 ou mais equipes trabalhem apenas com a documentação Mock servers
63. Como testar
65. Regras de Negócio ponta a ponta: Cadastro, verificar na listagem Aceitação - Regras de Negócio Cadastro API - Listagem API Cadastro API - Listagem Tela Cadastro Tela - Listagem API Exemplos de Combinações
66. Validando Schema
67. http://json-schema.org/
68. $ pip install jsonschema
70. "Document" Driven Development
71. Referências
74. Obrigado! Celso Crivelaro @celsocrivelaro Slides em: http://crivelaro.me