10 atributos de uma API de sucesso

Transcrição

1 10 atributos de uma API de sucesso Do design RESTful e segurança, a formas de divulgação e engajamento Kleber Bacili slideshare.net/kleberbacili

2 Cerquilho Kleber

3 Contextualização Planejamento e Preparação Agenda Design e Construção Execução e Engajamento

4 Contextualização

5 v Design, Exposição, Gerenciamento e Engajamento em APIs v Headquarter em Campinas, escritórios em Sampa, Rio e Philly v Classificados como Visionários no Quadrante Mágico do Gartner (*) Magic Quadrant for Integrated SOA Governance Technology Sets, 2009

6 ComparMlhando tudo com todos O Tempo todo com o usuário The Nexus of Forces Inundação de dados e contexto Implantanto e rodando em algum lugar Source: Gartner (Jun/2012)

7 The Internet of Things

8

9 10 Atributos de uma API de sucesso

10 Plan & Prepare API Strategy Run & Engage Design & Build

11 Plan & Prepare API Strategy Run & Engage Design & Build

12 As primeiras decisões de design

13 Selecione a Tecnologia Adequada SOAP vs. REST

14 Selecione a Tecnologia Adequada XML vs. JSON

15 and the winners are REST + JSON

16 1 Proposta de Valor

17 Você pode até passar batom num porco, mas ele cononuará sendo um porco!

18 Plan & Prepare API Strategy Run & Engage Muitos projetos; Design & & Equipe & Build pequena

19 2 Design RESTful

20 REST RepresentaMonal State Transfer EsMlo arquitetural criado por Roy Fielding RESTful Design que respeita os conceitos REST

21 Coleção Resources /pedidos! Elemento /pedidos/{id}!

22 RPC? /getaccount! /getallaccounts! /createdirectory! /updategroupname! /findclientbyid!

23 GET POST PUT DELETE

24 GET! POST! PUT! DELETE! Método de Consulta GET /vendas/pedidos! GET /checklist/item/4! PATCH!

25 GET! POST! PUT! DELETE! PATCH! Método para Criação POST /clientes/98w3g32k01/enderecos! {! "endereco": "Av. Brigadeiro Faria Lima",! "numero": "3800",! "complemento": "18o. Andar",! "bairro": "Itaim Bibi",! "cidade": "São Paulo",! "estado": "SP",! "cep": " "! }

26 GET! POST! PUT! DELETE! PATCH! Método para Atualização PUT /clientes/98w3g32k01/enderecos/1! {! "endereco": "Av. Brigadeiro Faria Lima",! "numero": "3820",! "complemento": "19o. Andar",! "bairro": "Itaim Bibi",! "cidade": "São Paulo",! "estado": "SP",! "cep": " "! }

27 GET! POST! PUT! DELETE! Método para Remoção DELETE /pedidos/{id}! DELETE /users/98w3g32k01/photos! PATCH!

28 GET! POST! PUT! DELETE! PATCH! Método para Atualização parcial PATCH /users/98w3g32k01! {! " ": } PATCH /pedidos/ ! {! "status": "Cancelado"! }

29

30 3 Versionamento

31 THINGS CHANGE! v1 v2 v3 v4 v5 v6 v7

32 Versionamento Versão URI: HTTP ou HTTPS Seu domínio Nome da API (opcional) Recursos e Parâmetros Outras alternamvas: Twilio: / /Accounts/ Salesforce.com: /services/data/v20.0/sobjects/account

33 4 Error Handling

34 200! 400! 500! Resultado OK Erro no Client Erro no Server

35 STATUS OK 200!

36 Status & Error Codes 200!!! 400!!! 500! 200 OK GET /candidatos?estado=sp&partido=pp! 200 OK! [! {! "id": " ",! "apelido": "PAULO MALUF",! "nome": "PAULO SALIM MALUF",! "numero": "1111",! "cargo": "Deputado Federal",! "estado": "SP",! "partido": "PP",! "reeleicao": true! }! ]!

37 Status & Error Codes 200!!! 400!!! 500! 201 Created POST /items/1234/bids! {! "amount" : ! } 201 Created! Location: /items/1234/bids/100001! {! "amount" : ,! "current_bid" : 510,! "winning" : true! }!

38 Status & Error Codes 200!!! 400!!! 500! 400 Bad Request GET /candidatos! 400 Bad Request! {! "status" : 400,! "code" : 40377,! "message" : "Parâmetro 'estado' não! pode ser nulo ou vazio"! "more" : }!

39 Status & Error Codes 200!!! 400!!! 500! 401!! 403! 404!! 413!! 429! Outros Comuns Unauthorized Forbidden Not Found Request is too Large Too Many Requests

40 Status & Error Codes 200!!! 400!!! 500! 500 Internal Server Error PUT /vendas/v1/pedidos/ ! {! status" : canceled! } 500 Internal Server Error! {! "status" : 500,! "message": Oops. Algo saiu errado! }! hmp://en.wikipedia.org/wiki/list_of_http_status_codes

41 Mais informações? Vídeo do Webinar hdp://downloads.sensedia.com/webinar- design- de- apis- resful

42 5 Segurança

43 v Acesso não autorizado v Ataques v Sobrecarga v Confidencialidade v Implementações desastradas de clients

44 v Acesso não autorizado v Ataques v Sobrecarga v Confidencialidade v Implementações desastradas de clients

45 Identidade e Autorização þ Identificar App (?) þ Identificar Usuário (?) þ Identificar Device (?)

46 HTTPS, sempre!

47 6 Hypermedia

48 Hypermedia APIs HATEOAS = Hypermedia as the Engine of ApplicaMon State *POX = Plain Old XML, Richardson Maturity Model

49 SEM Hypermedia GET /items?q=macbook+air+new {! "results" : [! {! "id" : 123,! "name" : "Macbook Air 2010 LIKE NEW",! "price" : "499"! }! ]! }

50 COM Hypermedia GET /items?q=macbook+air+new {! "results" : [! { "_links" : [! {"rel": "self","uri": "/items/123" },! {"rel": "bids","uri": "/items/123/bids" },! {"rel": "win","uri": "/items/123/bids?q=win" }! ],! "name" : "Macbook Air 2010 LIKE NEW",! "price" : "499" }! ]! }

51 Plan & Prepare API Strategy Muitos projetos; Run & Engage Equipe pequena Design & Build

52 7 Developers Portal

53 Docs incompletos, desatualizados, estáocos e com PDFs de 100 páginas

54 Gehng Started

55 desenvolvedores.extra.com.br! Documentação InteraOva

56 sendgrid.com/docs! Exemplos de código na linguagem do developer

57 8 Self- Service

58 stripe.com/docs! Sign- up e Tokens de acesso automáocos

59 REST Console ou Sandbox / Playgroung dev.transparencia.org.br!

60 9 Confiabilidade

61

62 Indisponibilidade Problemas de Performance Mudanças (não- planejadas) Bugs Confiabilidade Falta de Suporte

63 Trace de calls, Monitoramento, Rate LimiOng e Alertas

64 status.aws.amazon.com! Status Page, Release Notes, Blog

65 desenvolvedores.extra.com.br! Foruns de discussão e Abertura de Ockets

66 10 Divulgação

67 Hackathon & Open InnovaOon

68 1 Apps criadas: Developers cadastrados: Tráfego: 20M calls / 15 dias 4 Eleições mais transparentes!

69 Plan & Prepare API Strategy Run & Engage Design & Build

70 1 Proposta de Valor 6 Hypermedia 2 Design RESTful 7 Developers Portal 3 Versionamento 8 Self- Service 4 Error Handling 9 Confiabilidade 5 Segurança 10 Divulgação

71 Web- Services- Brasil Craoers- Brasil/

72

73 Kleber slideshare.net/kleberbacili