Alexandria: um Sistema de Sistemas para Publicação de Conteúdo Digital utilizando REST e Hípermídia.

Alexandria: um Sistema de
Sistemas para Publicação de
Conteúdo Digital utilizando
REST e Hipermídia

Luís Cipriani
@lfcipriani (twitter, linkedin, github, ...)
Seminário de Sistemas - IME (2013-04-08)

engineering.abril.com.br

talleye.com

hoje nós vamos falar sobre...

Someone published a new REST API

Let’s check it out!! o/

mmm...

just another HTTP-based RPC...
http://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven

por que há tanto mal
entendimento em
relação ao REST?

quem entende errado, está
fazendo errado?

boa
arquitetura =
custo
aceitável + necessidades
atendidas
* ß
MTRH

ß quão bem o seu cliente
sabe pedir o que quer :-P MTRH mean time to
recovery happiness

a nossa implementação
do estilo arquitetural para
sistemas baseados em
rede proposto pelo Roy
Fielding, mais conhecida
como...

“organizações que projetam sistemas são restritas a
produzir projetos que são cópias das estruturas de
comunicação dessas organizações”
Lei de Conway

http://www.melconway.com/Home/Conways_Law.html

gráﬁca

distribuidora

educação

Viaje Aqui

Recreio

Bravo!

Playboy Veja

CMS’s existem desde os anos 90.

Por que reiventamos a roda?

{
requisitos
negócios
Porque temos pessoas
alta diversidade orçamentos
de prioridades
culturas

Recreio

Bravo!

Playboy
diretoria digital

14 sites em produção
(em abr/2013)

50 desenvolvedores
12 arquitetos de software
6 Gerentes de Projeto
4 Gerentes de Produto
1 Advocate da Plataforma
(em abr/2013)

linguagens storage frameworks outros
• ruby • MongoDB • rails • Solr
• java • MySQL • sinatra • Hadoop
• javascript • Hbase • goliath • RabbitMQ
• HDFS • node.js • Varnish
• PostgreSQL • play • New Relic
• memcached • jetty
• redis • tokamak
• cachebag
• HTTPMonkey

https://github.com/abril

infraestrutura Alexandria + sites

• 91 VMs para ambientes dev, qa, stage
• AMC (Abril Mídia Cloud): private cloud (Xen/Open Stack)
• ou VMWare

• ~100 VMs + 16 físicas para produção
• Data center próprio, AWS, Heroku

• Total aproximado: 207 máquinas (abr/2013)

12,5 milhões de pageviews
(de 15/jan até 14/fev de 2013)

domínio

• acesso e manipulação de recursos
• implementa regras de negócio
• servidor HTTP + base de dados
• infra “isolada”
• ~ 8 domínios
• ex: editorial (matérias, galerias, etc), anotações
(comentários), estabelecimentos, mídia, pessoas

• consumo e manipulação de recursos
• servidor HTTP + (opcional base de dados)
• infra “isolada”
• ~ 12 serviços
• ex: console, socialcore, search, Abril ID, abr.io, etc

serviço

data-entry
• entrada da Redação
• aplicação web
• ~ 1 para cada domínio
• “API explorer”

Alexandria: um Sistema de Sistemas para Publicação de Conteúdo Digital utilizando REST e Hípermídia.

• admin do site sitetools
• manipulação das áreas e templates
• agiliza criação de produtos
• a fronteira com o usuário
• opcional

domínio

HTTP

data-entry sitetools
serviço

Por que escolhemos REST?

image from Roy Fielding dissertation (pag. 85)

Porque...

REST = LCODC$SS + U

o_O

REST = LCODC$SS + U
Client-Server

• Separação de responsabilidades
• Escalabilidade (simpliﬁcação)
• Evolução independente

http://byterot.blogspot.co.uk/2012/06/what-i-think-coupling-is.html

REST = LCODC$SS + U
Client-Server no Alexandria
• Separação de responsabilidades
• entre domínios e sites
• entre domínios e data entries
• entre domínios e serviços
• Escalabilidade
• funcionalidade implementada nos clients
• domínios só lidam com recursos (simplicidade)
• Evolução independente
• em certos pontos da arquitetura não há
• falta retro-compatibilidade

REST = LCODC$SS + U
Stateless

• Visibilidade
• Escalabilidade • Performance de rede
(recursos alocados)
• Conﬁabilidade

REST = LCODC$SS + U
Stateless no Alexandria

• HATEOAS implementado nas APIs
• cookies nas operações destrutivas

REST = LCODC$SS + U
Cache

• Eﬁciência • Conﬁabilidade
• Escalabilidade
• Performance
percebida pelo usuário

REST = LCODC$SS + U
Cache no Alexandria

• Built-in no protocolo HTTP
• shared-caches instanciados entre alguns nós
• pesquisa sobre caches locais
• nem todos os nós implementam estratégia de cache
• purge de recursos diretamente no cache

REST = LCODC$SS + U
Layered System

• Encapsula complexidade • Performance
• Evolvabilidade percebida pelo usuário
• Simplicidade

REST = LCODC$SS + U
Layered System no Alexandria

• shared-caches
• gateways para expor API para a Web
• balanceadores de carga
• encapsulamento de autenticação corporativa
• encapsulamento de legado
• permite evolução incremental do legado

REST = LCODC$SS + U
Code-on-demand

• Extensibilidade • Visibilidade
• Simpliﬁcação do client

REST = LCODC$SS + U
Code-on-demand no Alexandria

• widgets dos data-entries
• no futuro, o console também será instanciado assim
• é um elemento importante do REST que foi esquecido
por um tempo pela nossa arquitetura

REST = LCODC$SS + U
Uniform interface

• Simpliﬁcação pela generalidade • Performance
• Visibilidade percebida pelo usuário
• Desacoplamento • Restrita a dados com
• Evolvabilidade granularidade larga

REST = LCODC$SS +

Uniform interface no Alexandria

U resource identiﬁcation

URI
universal resource identiﬁer


/:tipo_recurso/:id


http://editorial.api.abril.com.br/materia/dicas

http://editorial.api.abril.com.br/materia/ac23657fg

http://bebe.abril.com.br/materia/ac23657fg

U resources
{
"tipo_recurso" : "materia",
"link" : [
{
"href" : "http://editorial.api.abril.com.br/materia/4f0dea5a1e13694",
"rel" : "self",
"type" : "application/json"
},
{
"href" : "http://editorial.api.abril.com.br/materias",
"rel" : "materias",
}
],
"id" : "http://editorial.api.abril.com.br/materia/4f0dea5a1e13694",
"slug" : "o-quintal-da-realeza",
"marca" : "viajeaqui",
"status" : "disponivel",
"descricao_conteudo" : "O quintal da realeza",
"fonte" : "viajeaqui",

(continua)

U resources
"criacao" : {
"usuario" : "Miguel Icassatti",
"data" : "2012-01-11T18:00:26-02:00"
},
"ultima_atualizacao" : {
"data" : "2012-01-19T16:47:18-02:00"
},
"disponibilizacao" : {
"data" : "2012-01-11T18:05:44-02:00"
},
"conteudos_relacionados" : [
{
"slug" : "4f0deb759d0a73284d00001e",
"link" : {
"href" : "http://editorial.api.abril.com.br/galerias_multimidia/4f0deb759d0a73284",
"rel" : "galeria_multimidia",
},
"preview" : "http://imgms.alexandria.abril.com.br/10/thumbnail-240x240-a1.jpeg",
"tipo_recurso" : "galeria_multimidia",
"fonte" : "viajeaqui",
"credito" : "(nÃ£o especificado)",
"descricao" : "Fotos das atraÃ§Ãµes e estabelecimentos de Windsor, cidade da
Inglaterra",
"id" : "http://editorial.api.abril.com.br/galerias_multimidia/4f0deb759d0a73284d00001e",
"titulo" : "Especial viajeaqui em Londres" (continua)

U resources
"rotulos_controlados" : [
"Londres2012"
],
"tags" : [
"Londres",
"restaurantes",
"atraÃ§Ãµes"
],
"editorias" : [
"MatÃ©rias"
],
"categorias" : [
"Turismo e Lazer",
"Turismo e Lazer::Cidade",
"Turismo e Lazer::PaÃs"
],
"autor" : "Miguel Icassatti",
"titulo" : "O quintal da realeza",
"chapeu" : "Windsor",
"subtitulo" : "Nossa viagem pela Inglaterra tem a primeira parada na histÃ³rica Windsor.",
"corpo" : "<p>Localizada Ã s margens do rio TÃ¢misa, que corta tambÃ©m Londres, a cidade de
Windsor jÃ¡ foi sede da monarquia britÃ¢nica.</p>"
}

U representations

e um tiquinho assim de XML

ou melhor,
de application/opensearchdescription+xml

U representations
<?xml version="1.0" encoding="UTF-8"?>
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/"
xmlns:grafo="http://socialcore.api.abril.com.br/grafo/busca">

<ShortName>Buscar relacionamentos</ShortName>
<Description>Busca de relacionamentos no grafo</Description>

<Url type="application/json"
template="http://socialcore.api.abril.com.br/grafo/busca?
usuario={grafo:usuario?}&tipo={grafo:tipo}"/>

<Query role="example"
title="Exemplo de valores dos parÃ¢metros"
grafo:usuario="id do usuario"
grafo:tipo="segue |seguido_por " />

</OpenSearchDescription>

U hypermedia

image from the book Rest in Practice (by Jim Webber) (pag. 14)

U hypermedia
Exercício: criar uma atividade de
um usuário no site.

Você só sabe o entrypoint:

http://socialcore.api.abril.com.br

U hypermedia

POST
http://socialcore.api.abril.com.br/
Accept:
application/json

U hypermedia
POST???

U hypermedia

HTTP/1.1 405 Method Not Allowed
Allow: GET

U hypermedia

GET
http://socialcore.api.abril.com.br/
Accept:
application/json

U hypermedia
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"titulo": "socialcore",
"link": [
{
"href": "http://socialcore.api.abril.com.br/",
"rel": "self",
"type": "application/json"
},
{
"href": "http://socialcore.api.abril.com.br/atividade",
"rel": "atividade",
},
{
"href": "http://socialcore.api.abril.com.br/grafo",
"rel": "grafo",
}
]
}

U hypermedia

GET
http://socialcore.api.abril.com.br/atividade
Accept:
application/json

U hypermedia
HTTP/1.1 200 OK
{
"titulo": "Entry Point de Atividades",
"link": [
{
"href": "http://socialcore.api.abril.com.br/atividade/template",
"rel": "template",
},
{
"href": "http://socialcore.api.abril.com.br/atividade/busca/descritor",
"rel": "search",
"type": "application/opensearchdescription+xml"
},
{
"href": "http://socialcore.api.abril.com.br/atividade/stat/descritor",
"rel": "stat",
}
]
}

U hypermedia

GET
http://socialcore.api.abril.com.br/atividade/template
Accept:
application/json

U hypermedia
HTTP/1.1 200 OK
{
"atividade": {
"app": "",
"created_at": "",
"usuario": "",
"tipo": "",
"objeto": {
"tipo": ""
},
"resultado": {
"tipo": ""
}
},

(continua)

U hypermedia
"link": [
{
"href": "http://socialcore.api.abril.com.br/atividade",
"rel": "atividade",
},
{
"href": "http://socialcore.api.abril.com.br/atividade/busca/descritor",
"rel": "search",
},
{
"href": "http://socialcore.api.abril.com.br/atividade/stat/descritor",
"rel": "stat",
}
]
}

U hypermedia
POST
Accept:
application/json
Content-‐Type:
application/json;
charset=utf-‐8
Authentication:
Basic
37rnx9w87rjdw87gri

{
"atividade": {
"app": "http://aapg.api.abril.com.br/produtos/1",
"created_at": 1325086429,
"tipo": "comentar",
"objeto": {
"descricao": "Titulo da materia",
"id": "http://veja.abril.com.br/noticia/economia/confianca-da",
"tipo": "materia"
},
"resultado": {
"corpo": "otima materia",
"id": "http://veja.abril.com.br/noticia/economia/confianca-da/comments/1",
"tipo": "comentario"
}
}
}

U hypermedia
HTTP/1.1 422 Unprocessable Entity
{
"tipo_recurso":"erro",
"atividade":{
"usuario":"",
},
"erros":[
{"atributo":"usuario","mensagem":["é obrigatório"]}
]
}

U hypermedia
POST
Accept:
application/json
Content-‐Type:
application/json;
charset=utf-‐8
Authentication:
Basic
37rnx9w87rjdw87gri
{
"atividade": {
"app": "http://aapg.api.abril.com.br/produtos/1",
"created_at": 1325086429,
"usuario": "http://aapg.api.abril.com.br/usuarios/2",
"tipo": "comentar",
"objeto": {
"descricao": "Titulo da materia",
"id": "http://veja.abril.com.br/noticia/economia/confianca-da",
"tipo": "materia"
},
"resultado": {
"corpo": "otima materia",
"id": "http://veja.abril.com.br/noticia/economia/confianca-da/comments/1",
"tipo": "comentario"
}
}
}

U hypermedia

HTTP/1.1 201 Created
Location: http://socialcore.api.abril.com.br/atividade/0922307

o/

U application protocol
representation metadata
resource metadata

HTTP
status codes
control data

pontos importantes em performance
• performance dos • short stacks
connectors • evented servers
• non-blocking • libs padronizadas
HTTP clients

client • caches
• HTTP plumbing origin server
• cache local
• middleware • good TTL strategy
architecture • middleware
• libs padronizadas architecture

• Lei de Postel
• Seja conservador no que faz, seja liberal no que você aceita dos outros
• REST é uma arquitetura de longo prazo
• Defenda com todas as suas forças:
• seus metadados (recursos)
• sua interface

• Documentação é essencial
• Independência de desenvolvimento dos nós tem
suas desvantagens

• medir/monitorar o desempenho é importantíssimo

Assumimos que nossa arquitetura está válida.

mas...

custo
aceitável + necessidades
atendidas
* ß
MTRH

e quando REST não
for suﬁciente?

• bit.ly/abril_qcon_refs
• engineering.abril.com.br Obrigado!
• talleye.com
• digital.abril.com.br

Alexandria: um Sistema de Sistemas para Publicação de Conteúdo Digital utilizando REST e Hípermídia.

Recomendados

Mais conteúdo relacionado

Semelhante a Alexandria: um Sistema de Sistemas para Publicação de Conteúdo Digital utilizando REST e Hípermídia. (20)

Mais de Luis Cipriani (10)

Último (15)

Alexandria: um Sistema de Sistemas para Publicação de Conteúdo Digital utilizando REST e Hípermídia.