Desenvolvendo APIs de Alta Performance

Palestra proferida nas dependências da Dataprev Rio sobre os aspectos que impactam na performance e na qualidade de uso de APIs.

Transcript

1. Desenvolvendo APIs de Alta Performance Ricardo Coelho @ramcoelho Dataprev, 1392984000
2. API pra que? WS API Client
3. Um Programa Navegador
4. Scrapers
5. O Mundo Real
6. http://techcrunch.com/2011/08/11/facebook-wins-worst-api-in-developer-survey/ Facebook Wins “Worst API” in Developer Survey Não Estamos Sozinhos
7. Problemas Comuns Documentação Ausente ou Insuficiente
8. Problemas Comuns Tratamento Ineficiente de Erros
9. Problemas Comuns Falta de Exemplos de Uso
10. Problemas Comuns Falta de Padronização
11. Problemas Comuns Inexistência de Ambientes de Testes
12. Problemas Comuns Mudanças na Interface
13. API e seus diversos formatos e regras de negócio que participam da entrega de dados ao cliente. Conjunto de Modais
14. API Eficiente Ações na aplicação Estabeleça um padrão e use-o Fundamental em aplicações móveis Entregar Dados Prontos
15. Ações no Backend Cache, Sharding, Replicação, Scale Up/Out, Proxy Reverso Reduzir a latência API Eficiente
16. Ações na transmissão Compressão, E-Tag, Controle de Cache, Content-MD5 Reduzir a Pegada de Banda API Eficiente
17. Reduzir a Pegada Compressão Accept-Encoding: gzip
18. Reduzir a Pegada HTTP/1.1 200 OK Access-Control-Allow-Origin: * Content-Type: text/javascript; charset=UTF-8 ETag: "beac06aec1862e7c6be256cbd76e37a902c07"
19. Respostas Parciais Host server.com.br GET /api/v1/recurso/id/15 ! ?campos=nome,valor,data Reduzir a Pegada
20. Use os códigos de estado HTTP 200 OK ! { “is_error”: true, “message”: “Not found” } 404 Not Found ! ! ! ! API Eficiente
21. Use os verbos HTTP GET /api/v1/recurso/criar ! { “nome”: “Ricardo”, … } PUT /api/v1/recurso ! { “nome”: “Ricardo”, … } API Eficiente
22. Update em Campos Específicos PATCH /api/v1/recurso/ HTTP/1.1 Host: servidor.com.br Content-Type: application/json-patch ! [ {"replace": "nome", "value": “Ricardo Coelho"} ] Reduzir a Pegada
23. Update em Campos Específicos POST /api/v1/recurso/ HTTP/1.1 X-HTTP-Method-Override: PATCH Host: servidor.com.br Content-Type: application/json-patch ! [ {"replace": "nome", "value": “Ricardo Coelho"} ] Reduzir a Pegada
24. PATCH /api/v1/recurso/ HTTP/1.1 Host: servidor.com.br Content-Type: application/json-patch ! [ {“replace”: “nome”, “value”: “Ricardo Coelho”}, {“unset”: “faltas”}, {“add”: “ferias”, “value”: { “inicio”: “2014-01-05”, “fim”: “2014-02-04” } } ] Reduzir a Pegada
25. PATCH /api/v1/recurso/ HTTP/1.1 Host: servidor.com.br Content-Type: application/json-patch ! [ {“nome”: “Ricardo Coelho”}, {“faltas”: null}, {“ferias”: { “inicio”: “2014-01-05”, “fim”: “2014-02-04” } } ] Reduzir a Pegada
26. OPTIONS /api/v1/recurso/ HTTP/1.1 Host: servidor.com.br Content-Type: application/json-patch ! { “_comment”: “bla, bla, bla”, “format”: { “id”: “int”, “nome”: “string”, “faltas”: [ “datetime” ] “ferias”: { “inicio”: “date”, “fim”: “date” } } } Documentação para Sistemas
27. Obrigado
28. Perguntas?