You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
346 lines
10 KiB
346 lines
10 KiB
<!doctype html> |
|
<html lang="en"> |
|
|
|
<head> |
|
<meta charset="utf-8"> |
|
|
|
<title>ReST - Restructured State Transfer</title> |
|
|
|
<meta name="author" content="Julio Biason"> |
|
|
|
<meta name="apple-mobile-web-app-capable" content="yes" /> |
|
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" /> |
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no"> |
|
|
|
<link rel="stylesheet" href="_external/reveal.min.css"> |
|
<link rel="stylesheet" href="_external/default.css" id="theme"> |
|
|
|
<!-- For syntax highlighting --> |
|
<link rel="stylesheet" href="_external/zenburn.css"> |
|
|
|
<!-- If the query includes 'print-pdf', include the PDF print sheet --> |
|
<script> |
|
if( window.location.search.match( /print-pdf/gi ) ) { |
|
var link = document.createElement( 'link' ); |
|
link.rel = 'stylesheet'; |
|
link.type = 'text/css'; |
|
link.href = '_external/pdf.css'; |
|
document.getElementsByTagName( 'head' )[0].appendChild( link ); |
|
} |
|
</script> |
|
|
|
<!--[if lt IE 9]> |
|
<script src="reveal.js/lib/js/html5shiv.js"></script> |
|
<![endif]--> |
|
|
|
<style> |
|
img { |
|
height: 400px; |
|
} |
|
|
|
.semi-opaque { |
|
background-color: rgba(0, 0, 0, 0.7); |
|
} |
|
|
|
* { |
|
hyphens: none !important; |
|
-moz-hyphens: none !important; |
|
} |
|
</style> |
|
</head> |
|
|
|
<body> |
|
|
|
<div class="reveal"> |
|
<!-- Any section element inside of this container is displayed as a slide --> |
|
<div class="slides"> |
|
<section data-background='_images/Seascapeshd.png' class='semi-opaque'> |
|
<h1>ReST</h1> |
|
<h4>Restructured State Transfer</h4> |
|
</section> |
|
|
|
<section> |
|
<ul> |
|
<li>Criado por Roy Fielding em 2000.</li> |
|
<li>Fielding trabalhou na definição do HTTP e no início do projeto Apache.</li> |
|
</ul> |
|
</section> |
|
|
|
<section> |
|
<h2>O que é ReST?</h2> |
|
<img src='_images/l-What-is-this-sorcery.jpg'></img> |
|
</section> |
|
|
|
<section> |
|
<p>É uma "arquitetura" de transmissão de dados sobre HTTP.</p> |
|
|
|
<p>("Conjunto de idéias para utilizar HTTP para geração de APIs.")</p> |
|
</section> |
|
|
|
<section> |
|
<p>Linguagem? Qualquer!</p> |
|
|
|
<ul> |
|
<li>Python: Flask, Django, Flask-Restless, Django Rest Framework</li> |
|
<li>Ruby: Ruby on Rails, Sinatra</li> |
|
<li>Java: Spring, Restlet, Jersey</li> |
|
<li>C#: Ramone</li> |
|
<li>Nodejs: Express</li> |
|
<li>Rust: Rustful</li> |
|
</dl> |
|
</section> |
|
|
|
<section> |
|
<h2>ReST e HTTP</h2> |
|
<img src='_images/20090504102402_dsc_2864 (1).jpg'></img> |
|
</section> |
|
|
|
<section> |
|
<ul> |
|
<li>Métodos HTTP = operação de banco de dados (CRUD).</li> |
|
<li>Resultado das operações são indicados por status HTTP.</li> |
|
<li>Meta-informações podem ser enviadas nos headers. |
|
<ul> |
|
<li>Por exemplo, atenticação é feita por HTTP auth.</li> |
|
</ul> |
|
</li> |
|
<li>Sem transações/sessões -- todas as operações são atômicas.</li> |
|
</ul> |
|
</section> |
|
|
|
<section> |
|
<p>Em HTTP, usam-se métodos para descrever o que quer ser feito:</p> |
|
|
|
<ul> |
|
<li><code>POST</code> requisita informações, com conteúdo.</li> |
|
<li><code>GET</code> requisita informações, sem conteúdo.</li> |
|
</ul> |
|
|
|
<p class='fragment'>(Ainda: PUT, DELETE, HEAD, TRACE, PATCH, OPTIONS)</p> |
|
</section> |
|
|
|
<section> |
|
<p>Em ReST, métodos HTTP viram CRUD:</p> |
|
|
|
<ul> |
|
<li>Create ⇒ POST</li> |
|
<li>Retrieve ⇒ GET</li> |
|
<li>Update ⇒ PUT</li> |
|
<li>Delete ⇒ DELETE</li> |
|
<li class='fragment'>Update ⇒ PATCH</li> |
|
</ul> |
|
</section> |
|
|
|
<section> |
|
<h2>Recursos</h2> |
|
<img src='_images/jellybeans.jpg'></img> |
|
</section> |
|
|
|
<section> |
|
<ul> |
|
<li>Em ReST, as "tabelas" são chamadas "recursos".</li> |
|
<li>Sempre substantivos no plural.</li> |
|
<li>Duas URLs por recurso |
|
<ul> |
|
<li>Uma para o conjunto;</li> |
|
<li>Uma para elementos específicos.</li> |
|
</ul> |
|
</li> |
|
</ul> |
|
</section> |
|
|
|
<section> |
|
<h3>URLs para o Recurso</h3> |
|
|
|
<ul> |
|
<li><code>GET /recurso/</code> ⇒ retorna todos os elementos do recurso.</li> |
|
<li><code>POST /recurso/</code> ⇒ cria um novo elemento.</li> |
|
<li><code>PUT /recurso/</code> ⇒ atualização em massa.</li> |
|
<li><code>DELETE /recurso/</code> ⇒ remove todos os elementos do recurso.</li> |
|
</ul> |
|
</section> |
|
|
|
<section> |
|
<h3>URLs para o Elemento</h3> |
|
|
|
<ul> |
|
<li><code>GET /recurso/id</code> ⇒ retorna as informações do elemento com identificador "id".</li> |
|
<li><code>POST /recurso/id</code> ⇒ proibído, use <code>POST /recurso/</code> para criar elementos.</li> |
|
<li><code>PUT /recurso/id</code> ⇒ atualiza as informações do elemento.</li> |
|
<li><code>DELETE /recurso/id</code> ⇒ remove o elemento com identificador "id".</li> |
|
</ul> |
|
</section> |
|
|
|
<section> |
|
<h3>Exemplos</h3> |
|
|
|
<ul> |
|
<li><code>GET /users/</code> ⇒ Retorna a lista de todos os usuários.</li> |
|
<li><code>POST /users/</code> ⇒ Cria um novo usuário.</li> |
|
<br/> |
|
<li><code>GET /users/1</code> ⇒ Retorna as informações do usuário com id "1".</li> |
|
<li><code>PUT /users/1</code> ⇒ Atualiza as informações do usuário "1".</li> |
|
<li><code>DELETE /users/1</code> ⇒ Remove o usuário "1".</li> |
|
</ul> |
|
</section> |
|
|
|
<section> |
|
<h3>Requisições sem recursos</h3> |
|
|
|
<p>Requisições sem um recurso definido utilizam um verbo e GET:</p> |
|
|
|
<p><code>GET /convert/?source=BRL&value=10&target=AUD</code></p> |
|
</section> |
|
|
|
<section> |
|
<h2>Conteúdo</h2> |
|
<img src='_images/content-strategy.jpg'></img> |
|
</section> |
|
|
|
<section> |
|
<h3>Formato das respostas/requisições</h3> |
|
|
|
<p>Qualquer formato, ReST não define um específico.</p> |
|
|
|
<ul> |
|
<li>XML</li> |
|
<li>JSON</li> |
|
<li>HTML (www-form-encoded)</li> |
|
<li>CNAB</li> |
|
</ul> |
|
|
|
<p>Fica a cargo da equipe decidir o melhor formato para a aplicação.</p> |
|
</section> |
|
|
|
<section> |
|
<h2>Resultado das operações</h2> |
|
<img src='_images/RightWrongBlackboard.jpg'></img> |
|
</section> |
|
|
|
<section> |
|
<p>São utilizados os status HTTP</p> |
|
|
|
<ul> |
|
<li>200 OK ⇒ operação concluída com sucesso.</li> |
|
<li>400 Bad Request ⇒ algo errado com a requisição.</li> |
|
<li>401 Unauthorized ⇒ o usuário informado não tem permissão para acessar o recurso.</li> |
|
<li>403 Forbidden ⇒ precisa de autenticação e essa não foi informada.</li> |
|
<li>404 Not Found ⇒ recurso ou elemento não existe.</li> |
|
<li>405 Method Not Allowed ⇒ metódo inválido para recurso/elemento (p.ex. "POST" num elemento)</li> |
|
</ul> |
|
|
|
<p>E assim por diante...</p> |
|
|
|
<p class='fragment'>Entretanto...</p> |
|
</section> |
|
|
|
<section> |
|
<h3>Problema</h3> |
|
|
|
<p>ReST não define o que fazer em caso de conflito dos erros.</p> |
|
</section> |
|
|
|
<section> |
|
<h3>Exemplo</h3> |
|
|
|
<p>Operação para adicionar um usuário à um grupo:</p> |
|
|
|
<ul> |
|
<li>404 se o grupo não existir;</li> |
|
<li>Qual status a ser retornado quando o usuário não existe, neste caso?</li> |
|
</ul> |
|
|
|
<p>Normalmente é enviado um corpo indicando o erro de forma mais completa, |
|
ainda com status HTTP.</p> |
|
</section> |
|
|
|
<section> |
|
<h2>Por que usar ReST?</h2> |
|
<img src='_images/house-do-want_cut455_22k.jpg'></img> |
|
</section> |
|
|
|
<section> |
|
<ul> |
|
<li>Reaproveita toda a estrutura HTTP existente.</li> |
|
<li>HTTP praticamente padrão em todas as linguagens "na caixa". |
|
<ul> |
|
<li>(E, se não tiver, o protocolo é simples o suficiente para uma |
|
implementação na hora.) |
|
</ul> |
|
</li> |
|
<li>Dificilmente portas HTTP (80 e 443) são bloqueadas em proxies.</li> |
|
<li>"Sintaxe" simples.</li> |
|
</ul> |
|
</section> |
|
|
|
<section> |
|
<h2>Por que não usar ReST?</h2> |
|
<img src='_images/Luke-Derp.jpg'></img> |
|
</section> |
|
|
|
<section> |
|
</section> |
|
|
|
<section> |
|
<ul> |
|
<li>Segurança depende de terceiros (HTTPS). |
|
<ul> |
|
<li>Existem outras opções (OAuth, por exemplo), mas são complexas e não se parecem |
|
com soluções HTTP.</li> |
|
</ul> |
|
</li> |
|
<li>Não recomendado para dispositivos com processamento e memória |
|
extremamente limitados.</li> |
|
<li>Necessidade de sessões/transações.</li> |
|
<li>Requisito não é um serviço.</li> |
|
</ul> |
|
</section> |
|
|
|
<section></section> |
|
|
|
<section data-background='_images/thats-all-folks.jpg'> |
|
<p></p> |
|
</section> |
|
|
|
<section class='semi-opaque' data-background='_images/thats-all-folks.jpg'> |
|
<p><small>Perguntas?</small></p> |
|
</section> |
|
</div> |
|
</div> |
|
|
|
<script src="_external/head.min.js"></script> |
|
<script src="_external/reveal.min.js"></script> |
|
|
|
<script> |
|
|
|
// Full list of configuration options available here: |
|
// https://github.com/hakimel/reveal.js#configuration |
|
Reveal.initialize({ |
|
controls: true, |
|
progress: true, |
|
history: true, |
|
center: true, |
|
|
|
theme: 'night', |
|
transition: 'linear', |
|
|
|
// Parallax scrolling |
|
// parallaxBackgroundImage: 'https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg', |
|
// parallaxBackgroundSize: '2100px 900px', |
|
|
|
// Optional libraries used to extend on reveal.js |
|
dependencies: [ |
|
{ src: '_external/classList.js', condition: function() { return !document.body.classList; } }, |
|
{ src: '_external/marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } }, |
|
{ src: '_external/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } }, |
|
{ src: '_external/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } }, |
|
{ src: '_external/zoom.js', async: true, condition: function() { return !!document.body.classList; } }, |
|
{ src: '_external/notes.js', async: true, condition: function() { return !!document.body.classList; } } |
|
] |
|
}); |
|
|
|
</script> |
|
|
|
</body> |
|
</html>
|
|
|