Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Projeto de APIs
Search
Celso Crivelaro
October 08, 2017
Technology
0
140
Projeto de APIs
O que pensar para APIs públicas,
[micros]serviços e SPAS
Celso Crivelaro
October 08, 2017
Tweet
Share
More Decks by Celso Crivelaro
See All by Celso Crivelaro
Sistemas de Recomendação
celsocrivelaro
2
200
Big Data para Gerentes de Projetos
celsocrivelaro
0
45
FileSystems em Ruby com FUSE
celsocrivelaro
2
55
Padrões e Boas Práticas de Teste de Tela
celsocrivelaro
0
390
Testing Network Conditions with ToxiProxy
celsocrivelaro
1
330
Testing Network Conditions with ToxiProxy
celsocrivelaro
0
77
Actor Model in Ruby
celsocrivelaro
0
230
Separando as regras de negócios do Rails
celsocrivelaro
0
170
InfluxDB + Grafana
celsocrivelaro
0
240
Other Decks in Technology
See All in Technology
エンジニアリングマネージャーはどう学んでいくのか #devsumi / How Do Engineering Managers Continue to Learn and Grow?
expajp
4
1.3k
年間一億円削減した時系列データベースのアーキテクチャ改善~不確実性の高いプロジェクトへの挑戦~
lycorptech_jp
PRO
3
2.9k
可視化プラットフォームGrafanaの基本と活用方法の全て
hamadakoji
0
230
Matterport を使ってクラスメソッド各拠点のバーチャルオフィスツアーを作成してみた
wakatsuki
0
160
Datadog Cloud SIEMを使ってAWS環境の脅威を可視化した話/lifeistech-datadog-cloud-siem
gidajun
0
480
エンジニア向け会社紹介資料
caddi_eng
14
220k
OSSコミットしてZennの課題を解決した話
dyoshikawa1993
0
150
楽しくGoを学び合う、LayerXの勉強会文化 / LayerX's study culture of having fun and learning Go together
ar_tama
2
350
Luupの開発組織におけるインシデントマネジメントの変遷 ver.RoadtoSRENEXT2024
grimoh
1
270
累計ダウンロード数1億8000万を超えるアプリケーションプラットフォームのレガシーシステム脱却とモダン化への道
kmitsuhashi
0
120
VPoEの視点から見た、ヘンリーがサーバーサイドKotlinを使う理由 / Why Server-side Kotlin 2024
cho0o0
1
420
AWSでRAGを作る法方
sonoda_mj
1
140
Featured
See All Featured
What's new in Ruby 2.0
geeforr
338
31k
The Straight Up "How To Draw Better" Workshop
denniskardys
229
130k
How GitHub (no longer) Works
holman
305
140k
Making Projects Easy
brettharned
111
5.7k
Dealing with People You Can't Stand - Big Design 2015
cassininazir
360
22k
CSS Pre-Processors: Stylus, Less & Sass
bermonpainter
353
29k
The Cost Of JavaScript in 2023
addyosmani
31
4.7k
Design by the Numbers
sachag
277
18k
[Rails World 2023 - Day 1 Closing Keynote] - The Magic of Rails
eileencodes
17
1.5k
Fontdeck: Realign not Redesign
paulrobertlloyd
79
5.1k
I Don’t Have Time: Getting Over the Fear to Launch Your Podcast
jcasabona
26
1.8k
Easily Structure & Communicate Ideas using Wireframe
afnizarnur
189
16k
Transcript
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