Construindo uma API RESTful para android

deepday 2015

Welington Galvão

galvao.eu@gmail.com

Application Programming Interface

APIs fechada

APIs abertas

Design RPCgetUser()addUser()removeUser()updateUser()getLocation()addLocation()removeLocation()updateLocation()listUsers()listLocations()findLocation()findUser()

Design RESTful Usuario {} Localizacao {}

Fonte: https://www.flickr.com/services/api/

RESTRepresentational State Transfer 

RESTfulDesigner que respeita os padrões da arquitetura REST

JSONx

XML

URI: http://suaempresa.com/deepday/clientes/1 

Estrutura mínima

http ou https 

endereço do domínio 

nome da api Recursos e parâmetros

Resources

Coleção/clientes

Resources

Elemento/clientes/4

Operações http

Resource POSTcreate

GETread

PUTUpdate, create

DELETEdelete

/clientes Cria um novo cliente

Retorna uma lista de todos clientes

------------ Apaga todos os clientes

/clientes/11 --- Mostra detalhes do cliente 11

Atualiza cliente 11, caso não exista ele o cria

Apaga o cliente 11

Códigos de erroStatus code

404

Códigos de erro/Status codeCódigo Descrição

1xx Resposta provisória

2xx Bem-sucedido

200 (Bem-sucedido) 201 (Criado)

3xx Redirecionado

301 (Movido permanentemente)

4xx Erro de solicitação

403 (Proibido)404 (Não encontrado)

5xx Erro no servidor

501 (Não implementado)504 (Tempo limite do gateway)

Fonte: https://support.google.com/webmasters/answer/40132?hl=pt-BR

Segurança

Identificar e autorizar

Versionamento

URI: http://suaempresa.com/deepday/v1/clientes/1 

Versionamento

http ou https 

endereço do domínio 

nome da api Recursos e parâmetros

Versão da api

Materiais e softwares

API deepdayhttps://github.com/wgalvao/api-deepday

Obrigado