O documento apresenta uma palestra sobre APIs RESTful e o framework FRAPI. A palestra discute conceitos fundamentais de APIs e arquitetura REST, demonstra como construir uma API RESTful de casos Ufológicos usando o FRAPI e gera documentação automática para a API.

1. RESTFUL webservicesConstruindo Apis
http://bit.ly/ZhgkiB

2. Agenda
Eu
API's
Frapi
Demo

3. Mercantólogo por formação, desenvolvedor por paixão!
Ativista por consciência!
Alex Piaz (@zaip)
alex@piaz.com.br
http://www.zaip.net

4. Há 15+ anos nas interwebs...

5. Há 13 anos...
1998

6. Há 7 anos...
1998
www.socioambiental.org

7. Gleilson Miranda/Secretaria de Comunicação do Estado do Acre/FUNAI

8. Chefe Almir Suruí

9. 1998

10. É só fazer um "XML" que
resolve....

11. É só fazer um "XML" que
resolve....

12. Ao vivo é muito pior!

13. Ao vivo é muito pior!
http://www.youtube.com/watch?v=9C-IDT__1HE

14. APIhttp://en.wikipedia.org/wiki/Application_programming_interface

15. UMA API É UM CONTRATO !

16. Controle de acesso

17. IDENTIFICACAO
http://blogs.estadao.com.br/radar-pop/homem-e-preso-em-recife-por-apresentar-rg-com-foto-de-jack-nicholson/

18. Autorização

19. Uso

20. Documentação

21. Formatos de saída

22. versões

23. Mensagens!

24. ReST
Representational State Transfer

25. http://alganet.github.io/rest-client-side/#/rest-roy

26. Estilo Arquitetural

27. HTTP
RFC 2616

28. HTTP PARA DESIGNERS
Cliente / Servidor
Interface Uniforme
Camadas
Stateless
Cache

29. ReSTafarianos x Pragmaresticos

30. ReST Constraints
● Cliente/Servidor
● Interface Uniforme
● Cache
● Stateless
● Camadas
● Código sob demanda *

31. Recursos :: URLs + Verbos HTTP
Interface Uniforme
GET http://api.piaz.com.br/ufoapi/v1/casos/1
POST http://api.piaz.com.br/ufoapi/v1/casos/1
PUT http://api.piaz.com.br/ufoapi/v1/casos/1
DELETE http://api.piaz.com.br/ufoapi/v1/casos/1
HEAD http://api.piaz.com.br/ufoapi/v1/casos/1
Recursos são substantivos
Prefira o plural ao singular
2 URLs por recurso

32. Manipulação dos recursos através de suas representações
Interface Uniforme
GET http://api.piaz.com.br/ufoapi/v1/casos/1

33. Mensagens auto-descritivas
Interface Uniforme
Cabeçalhos e Status Codes do HTTP
1xx - Informativo
2xx - Sucesso
3xx - Redirecionamento
4xx - Erro do cliente
5xx - Erro do servidor

34. http://stateless.co/hal_specification.html
HAL
Hypertext Application Language
HATEOAS - Hypermedia as the Engine of Application State
Interface Uniforme
{
"_links": {
"self": { "href": "/ufoapi/v1/casos/2" },
"next": { "href": "/ufoapi/v1/casos/3" },
"prev": { "href": "/ufoapi/v1/casos/1" },
} ,
}
WRML
Web resource modeling language
http://www.wrml.org/modelingLanguage

35. Richardson Maturity Model

36. E o FRAPI entra em cena!
http://getfrapi.com

37. FRAMEWORK API

38. INSTALAÇÃO

39. INSTALAÇÃO / Requisitos mínimos
○ Webserver (apache, nginx, iis)
○ PHP >= 5.2.4
○ gettext
○ XMLWriter
○ PEAR
○ APC *
* Pode ser instalado sem o APC ou com outro
mecanismo de caching mas não é recomendado
http://frapi.github.com/installing/caching.html
http://frapi.github.com/installing/index.html

40. git clone git://github.com/frapi/frapi.git
git clone git://github.com/zaip/frapi.git
ou
wget https://github.com/frapi/frapi/tarball/master
tar -xzvf frapi-frapi-VERSION.tar.gz
FRAPI_PATH = local/onde/voce/desempacotou/o/frapi
INSTALAÇÃO / Obtendo o software

41. Interface administrativa API Pública
Camadas de interação
● Zend Framework
● Actions e Errors
● Autenticação
● Documentação
● Ambiente de testes
● Produção
● PHP
● Cache
● Request
● Response
Interface CLI
● Admin via terminal

42. <VirtualHost *:80>
ServerName admin.frapi
DirectoryIndex index.php
ServerAdmin admin@api.frapi
# This should be omitted in the production
environment
SetEnv APPLICATION_ENV development
DocumentRoot FRAPI_PATH/src/ frapi/admin/public
<Directory FRAPI_PATH/src/frapi/admin/public>
AllowOverride All
Order deny,allow
Allow from All
</Directory>
</VirtualHost>
Interface Administrativa
<VirtualHost *:80>
ServerName api.frapi
ServerAdmin admin@api.frapi
DocumentRoot FRAPI_PATH/src/ frapi/public
# This should be omitted in the production
environment
SetEnv APPLICATION_ENV development
<Directory FRAPI_PATH/src/frapi/public>
AllowOverride All
Order deny,allow
Allow from All
</Directory>
</VirtualHost>
API Pública
INSTALAÇÃO / Configurando
2 virtual host
Permissões de acesso
chown -R username.web-user FRAPI_PATH
chmod 775 FRAPI_PATH/src/frapi/custom/Action
chmod 775 FRAPI_PATH/src/frapi/custom/Config/
chmod 664 FRAPI_PATH/src/frapi/custom/Config/*.xml

43. Dá pra instalar sem 2 vhosts?
http://www.felipemarques.com.br/tag/alex-piaz/
SIM

44. INSTALAÇÃO / Finalizando

48. UFO API
Principais casos da Ufologia Mundial REST!
CRUD

49. UFO API
Modelo
Mensagens de erro (Not found [404] / NO PUT/DELETE/POST [405] )
2 URLs === 2 actions
//api.piaz.com.br/ufoapi/v1/casos (GET POST)
//api.piaz.com.br/ufoapi/v1/casos/{id} (GET PUT DELETE)
Complexidade vai na Query String
//api.piaz.com.br/ufoapi/v1/casos?pais=Brasil
Principais casos da Ufologia Mundial em ReSTFul!

50. UFO APIPrincipais casos da Ufologia Mundial REST!
Custom_Model_Caso()
getCasos()
getCaso($id)
getCasosPorPais($pais)
insertCaso($data)
updateCaso($id,$data)
deleteCaso($id)

51. FRAPI_PATH/src/frapi/custom/Action

52. UFO APIPrincipais casos da Ufologia Mundial em ReSTFul!
Métodos disponibilizados pelo FRAPI
executeGet()
executePost()
executePut()
executeDelete()
executeHead()http://frapi.github.com/developing/coding-actions.html

53. UFO APIPrincipais casos da Ufologia Mundial em ReSTFul!
Mensagens de erro
http://en.wikipedia.org/wiki/List_of_HTTP_status_codes

54. UFO APIAction Casos - http://ufo-api.piaz.com.br/casos (GET POST HEAD)

55. UFO APIAction Casos - http://api.piaz.com.br/ufoapi/v1/casos (GET)

56. UFO APIAction Casos - http://api.piaz.com.br/ufoapi/v1/casos (POST)

57. UFO APIAction Casos - http://api.piaz.com.br/ufoapi/v1/casos (HEAD)

58. UFO APIPrincipais casos da Ufologia Mundial ReST!
http://api.piaz.com.br/ufoapi/v1/casos/{id} (POST PUT DELETE)

59. UFO APIAction Caso - http://api.piaz.com.br/ufoapi/v1/casos/{id} (GET)

60. UFO APIAction Caso - http://api.piaz.com.br/ufoapi/v1/casos/{id} (PUT)

61. UFO APIAction Caso - http://api.piaz.com.br/ufoapi/v1/casos/{id} (DELETE)

62. Gerando documentação...
http://frapi-admin/docs/generate/format/text
http://frapi-admin/docs/generate/format/html
http://frapi-admin/docs/generate/format/mdown
http://frapi-admin/docs/generate/format/pdf

64. Utilidades
implementing-rest
Exploring the implementation aspects of the REST architectural style.
https://code.google.com/p/implementing-rest/
PostMan - Rest Client para o Chrome
https://chrome.google.com/webstore/detail/fdmmgilgnpjigdojojpjoooidkmcomcm
Tese do Roy Fieldling (nascimento do ReST)
http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm
Richardson Maturity Model
http://martinfowler.com/articles/richardsonMaturityModel.html
Swagger (Documentação para sua API)
https://developers.helloreverb.com/swagger/
API Best Pratices
http://apigee.com/about/api-best-practices
HTTP (RFC 2616)
http://tools.ietf.org/html/rfc2616

65. Arquivos desta palestra
https://www.dropbox.
com/sh/u0qqmm49ursrtpg/mofogHmsIi