Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Sign up for free
Menu
Search
Features
All features
Private URLs
Password Protection
Custom URLS
Scheduled publishing
Remove Branding
Restrict embedding
Deck Collections
Notes
Features
All features
Private URLs
Password Protection
Custom URLS
Scheduled publishing
Remove Branding
Restrict embedding
Deck Collections
Notes
Explore
Featured decks
Featured speakers
Programming
Technology
Storyboards
Explore
Featured decks
Featured speakers
Programming
Technology
Storyboards
Pricing
Search
Sign in
Sign up for free
Projeto de APIs
Search
Celso Crivelaro
October 08, 2017
Technology
190
0
Share
Embed
Copy iframe code
Copy JS code
Copy link
Start on current slide
Projeto de APIs
O que pensar para APIs públicas,
[micros]serviços e SPAS
Celso Crivelaro
October 08, 2017
Transcript
74 slides
Projetos de APIs O que pensar para APIs públicas, [micros]serviços
e SPAS Celso Crivelaro @celsocrivelaro http://crivelaro.me
$whoami
Tech Lead @ Professor @
Motivação
None
None
None
Um caso curioso ...
Portal Usuário O que achávamos que deveria ser: Sistema Portal
Administrativo API HTTP Serviria aos Portais Serviria como API Externa
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
POST: Inserção em lote com Payloads Grandes API Externa API
com foco em sistema Schemas em formatos diferentes: JSON e XML
Muitas mudanças nas telas API Single Page Application API com
foco em usuário
Segundo caso curioso ...
Recebimento Core Processamento Transformação API HTTP Envio aos Provedores Recebimento
Processamento Transformação Envio aos Provedores
~ 8 milhões de consultas ao dia API Serviço Consulta
de informações para saldo e transformações Performance era um problema
Lições Aprendida
None
Tenha APIs diferentes para propósitos diferentes
Decisões arquiteturais têm impacto no negócio
Documente primeiro
Conheça seu público
Financeiro e Sistemas Tradicionais Público Geral Devs Iniciantes Equipe Interna
Equipe Terceira
Tipos de Integração Comuns
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
Bom para API Externa / Microsserviços Integração via WebService REST
ou SOAP Schema: XML, JSON, Binários
None
None
Desacopla a transmissão da mensagem Integração via Broker Regras de
Envio e distribuição Schema: XML, JSON, Binários
None
Segurança
Só se expor se necessário
Portal Usuário Sistema 1 Portal Administrativo Sistema 2 Sistema 3
WebService
Portal Usuário Sistema 1 Portal Administrativo Sistema 2 Sistema 3
Interfaces abertas para ataque Camada na Internet WebService
Portal Usuário Sistema 1 Portal Administrativo Sistema 2 Sistema 3
Serviço API Usuário Camada na Internet Rede Fechada WebService
Sempre por HTTPS
Autenticação
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
Sempre use autenticação, mesmo para serviço interno
Tarifação Operacional Problema: Pirata Operacional
Tarifação Operacional Problema: Pirata Operacional Rede Interna
Volume
Consulta -> Cache
Disponibilidade Tolerância ao Particionamento Consistência Efeito Colateral do Cache
Inserção
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
Validação de Schema Validação de Dados Problema: Payload Grande Inserção
Sistema 2 Sistema 1 Sistema 3 Sistema 4 Problema: Broadcast
Fácil para inserção Broker - Microsserviços Desacopla mensagem do transmissão
Problema: Manter mais uma infraestrutura
Sistema 1 Sistema 2 Problema: Lote
Pode-se enviar MBs ou GBs de um único arquivo Arquivos
- Microsserviços Usar AWS S3 ou mesmo SFTP Quando não há pressa
Versionamento
Breaking Changes
Remover um endpoint / fila / diretório Breaking Changes Adicionar
novo campo obrigatório Remover ou Alterar campo ou tipo
Como versionar
Nome do Recurso. Ex: HTTP POST#/v1/usuarios Versionamento Meta Informação: Ex:
HTTP Header X-Api-Version: 1 Não usar no payload
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
Schema
Enviar dados conhecidos pela App originadora [Micros]Serviços / WebService Metadados
Endereço de Callback
Documentação
1o Passo: Permite fazer o design Documentação Permite que 2
ou mais equipes trabalhem apenas com a documentação Mock servers
None
None
Como testar
None
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
Validando Schema
http://json-schema.org/
$ pip install jsonschema
None
"Document" Driven Development
Referências
None
None
Obrigado! Celso Crivelaro @celsocrivelaro Slides em: http://crivelaro.me
More Decks by Celso Crivelaro
See All by Celso Crivelaro
Sistemas de Recomendação
celsocrivelaro
2
250
Big Data para Gerentes de Projetos
celsocrivelaro
0
80
FileSystems em Ruby com FUSE
celsocrivelaro
2
79
Padrões e Boas Práticas de Teste de Tela
celsocrivelaro
0
470
Testing Network Conditions with ToxiProxy
celsocrivelaro
1
420
Testing Network Conditions with ToxiProxy
celsocrivelaro
0
96
Actor Model in Ruby
celsocrivelaro
0
280
Separando as regras de negócios do Rails
celsocrivelaro
0
210
InfluxDB + Grafana
celsocrivelaro
0
290
Other Decks in Technology
See All in Technology
3文字略語に騙されない! 世界一わかりやすい『EDR』超入門
kamadamakoto
1
270
ラクスル会社紹介資料|エンジニア向け / RAKSUL Introduction for Engineers
raksulrecruiting
0
130
Kansai WordPress Meetup@大阪『ブロックテーマを作る上で知っておくべきこと
torounit
0
250
メール到達性を支える、リンク先URLのドメイン評価の扱い方
wind111
0
160
IP重複は"ランディングVPC"で受け止める ― PrivateLink と Transit Gatewayによるマルチテナント接続基盤の設計
hatahata021
3
250
マネジメントされる側の仕事は「文句」を言うこと
riyaamemiya
7
5.8k
AWS基盤改善を支える 私たちの理念と行動指針
kentosuzuki
0
250
プロダクションコードにおける encoding/json から encoding/json/v2 へのスムーズな移行
sansantech
PRO
1
450
マネージャーをエスパーにしない マネジメントされる側から始める、働きやすい現場づくり
comi190327
1
780
設計手法を「道具」として使いこなすために
a_suenami
4
630
Oracle Base Database Service 技術詳細
oracle4engineer
PRO
17
120k
[関西Kaggler会 20261113] 続・コミュニティコンペのススメ
nejumi
0
150
Featured
See All Featured
How GitHub (no longer) Works
holman
316
150k
Data-driven link building: lessons from a $708K investment (BrightonSEO talk)
szymonslowik
1
1.4k
Primal Persuasion: How to Engage the Brain for Learning That Lasts
tmiket
0
520
Measuring Dark Social's Impact On Conversion and Attribution
stephenakadiri
2
330
Fashionably flexible responsive web design (full day workshop)
malarkey
409
67k
How to Create Impact in a Changing Tech Landscape [PerfNow 2023]
tammyeverts
56
3.5k
No one is an island. Learnings from fostering a developers community.
thoeni
21
3.9k
Practical Orchestrator
shlominoach
192
12k
Done Done
chrislema
187
17k
Why Mistakes Are the Best Teachers: Turning Failure into a Pathway for Growth
auna
0
360
Everyday Curiosity
cassininazir
0
400
We Analyzed 250 Million AI Search Results: Here's What I Found
joshbly
2
2.1k