>>> RESTful API >>> Com Node.js e Restify. Name: Anderson Pimentel Date: 19 de Março de

Transcrição

1 >>> RESTful API >>> Com Node.js e Restify Name: Anderson Pimentel Date: 19 de Março de 2018 apds.anderson@icomp.ufam.edu.br [~]$ _ [1/31]

2 >>> Agenda 1. Introdução 2. Boas Práticas 3. Hands-on Ambiente 4. Referências [~]$ _ [2/31]

3 >>> Introdução Objetivo Desenho e Implementação de APIs Web. [1. Introdução]$ _ [3/31]

4 >>> Introdução Objetivo Desenho e Implementação de APIs Web. O minicurso se dará da seguinte forma: * > Fundamentos * > Hands-on [1. Introdução]$ _ [3/31]

5 >>> O que são APIs? * Acrônimo utilizado pela comunidade computacional e é denominado como Application Programming Interface [1. Introdução]$ _ [4/31]

6 >>> O que são APIs? * Acrônimo utilizado pela comunidade computacional e é denominado como Application Programming Interface * Interface de programação de aplicativos referentes ao método de comunicação entre duas entidades de código [1. Introdução]$ _ [4/31]

7 >>> O que são APIs? * Acrônimo utilizado pela comunidade computacional e é denominado como Application Programming Interface * Interface de programação de aplicativos referentes ao método de comunicação entre duas entidades de código * APIs servem para comunicar programas do mesmo computador [1. Introdução]$ _ [4/31]

8 >>> APIs Web * Comunicação entre várias máquinas em uma rede [1. Introdução]$ _ [5/31]

9 >>> APIs Web * Comunicação entre várias máquinas em uma rede * Possibilitam invocar a execução de código em outra máquina pela internet [1. Introdução]$ _ [5/31]

10 >>> APIs Web * Comunicação entre várias máquinas em uma rede * Possibilitam invocar a execução de código em outra máquina pela internet * Ótimas para controlar a exposição do código [1. Introdução]$ _ [5/31]

11 >>> APIs Web * Comunicação entre várias máquinas em uma rede * Possibilitam invocar a execução de código em outra máquina pela internet * Ótimas para controlar a exposição do código * Empresas mantém seus códigos privados sem ter que revelar o código real, apenas uma interface de comunicação. [1. Introdução]$ _ [5/31]

12 >>> APIs Web * Comunicação entre várias máquinas em uma rede * Possibilitam invocar a execução de código em outra máquina pela internet * Ótimas para controlar a exposição do código * Empresas mantém seus códigos privados sem ter que revelar o código real, apenas uma interface de comunicação. * Uma máquina pode usar várias APIs web para criar um aplicativo novo, conhecido como mashup [1. Introdução]$ _ [5/31]

13 >>> APIs Web A melhor maneira de prever o futuro é inventá-lo (Alan Kay, cientista da computação, em 1971) [1. Introdução]$ _ [6/31]

14 >>> APIs Web Qual o ganho de uma empresa por liberar conteúdo via APIs? [1. Introdução]$ _ [7/31]

15 >>> APIs Web Qual o ganho de uma empresa por liberar conteúdo via APIs? 1. Ajuda os desenvolvedores a criar novos soluções e serviços usando sua plataforma [1. Introdução]$ _ [7/31]

16 >>> APIs Web Qual o ganho de uma empresa por liberar conteúdo via APIs? 1. Ajuda os desenvolvedores a criar novos soluções e serviços usando sua plataforma 2. Promove a empresa [1. Introdução]$ _ [7/31]

17 >>> APIs Web Qual o ganho de uma empresa por liberar conteúdo via APIs? 1. Ajuda os desenvolvedores a criar novos soluções e serviços usando sua plataforma 2. Promove a empresa Resumindo: Implementar APIs Web acessíveis não é generosidade!! É um investimento lucrativo para muitas empresas. [1. Introdução]$ _ [7/31]

18 >>> Protocolo para APIs Web Definição Protocolos são regras estabelecidas para comunicação entre máquinas. [1. Introdução]$ _ [8/31]

19 >>> Protocolo para APIs Web Definição Protocolos são regras estabelecidas para comunicação entre máquinas. Uma abstração comum para conceitualizar isso é o modelo OSI (Open Systems Interconnection Model ) [1. Introdução]$ _ [8/31]

20 >>> Camada de Aplicação (HTTP, SSH, FTP) Podemos definir conceitualmente duas camadas acima da camada de aplicação: * Camada de Web Service * Camada de Formatação de Mensagem [1. Introdução]$ _ [9/31]

21 >>> Web Service [1. Introdução]$ _ [10/31]

22 >>> Web Service % SOAP [1. Introdução]$ _ [10/31]

23 >>> Web Service % SOAP! REST [1. Introdução]$ _ [10/31]

24 >>> Formatação de Mensagem [1. Introdução]$ _ [11/31]

25 >>> Formatação de Mensagem % XML [1. Introdução]$ _ [11/31]

26 >>> Formatação de Mensagem % XML! JSON [1. Introdução]$ _ [11/31]

27 >>> REST REST -> REpresentational State Transfer [1. Introdução]$ _ [12/31]

28 >>> REST REST -> REpresentational State Transfer [1. Introdução]$ _ [12/31]

29 >>> REST REST -> REpresentational State Transfer * Conjunto de estilos e guias, pois carrega recursos do HTTP com o objetivo de transmitir informação [1. Introdução]$ _ [12/31]

30 >>> REST REST -> REpresentational State Transfer * Conjunto de estilos e guias, pois carrega recursos do HTTP com o objetivo de transmitir informação * Usa verbos HTTP (get, post, put, delete entre outros) para lidar com o gerenciamento de recursos do servidor [1. Introdução]$ _ [12/31]

31 >>> REST REST -> REpresentational State Transfer * Conjunto de estilos e guias, pois carrega recursos do HTTP com o objetivo de transmitir informação * Usa verbos HTTP (get, post, put, delete entre outros) para lidar com o gerenciamento de recursos do servidor * Usa qualquer protocolo para estrutura de dados (xml, json e etc..) [1. Introdução]$ _ [12/31]

32 >>> JSON JSON -> JavaScript Object Notation [1. Introdução]$ _ [13/31]

33 >>> JSON JSON -> JavaScript Object Notation * Derivado do JavaScript [1. Introdução]$ _ [13/31]

34 >>> JSON JSON -> JavaScript Object Notation * Derivado do JavaScript * Pode reduzir significativamente o payload de transferência [1. Introdução]$ _ [13/31]

35 >>> Restrições e Características REST * Separação entre cliente e servidor (pull protocol ) [1. Introdução]$ _ [14/31]

36 >>> Restrições e Características REST * Separação entre cliente e servidor (pull protocol ) * Stateless [1. Introdução]$ _ [14/31]

37 >>> Restrições e Características REST * Separação entre cliente e servidor (pull protocol ) * Stateless * Cacheable [1. Introdução]$ _ [14/31]

38 >>> Restrições e Características REST * Separação entre cliente e servidor (pull protocol ) * Stateless * Cacheable * Uniform Interface [1. Introdução]$ _ [14/31]

39 >>> Akiry Tech Akiry Plataforma de distribuição de vídeos sob demanda(vod). [1. Introdução]$ _ [15/31]

40 >>> Akiry Tech [1. Introdução]$ _ [16/31]

41 >>> Akiry Tech (a) IcompTV Figura: Akiry Cases (b) TVUfamPlay [1. Introdução]$ _ [17/31]

42 >>> RESTful API Consiste em dois conceitos principais: * Recurso = Objeto associado com data ou identificado com uma URI * Representação = Forma como o recurso é mostrado [1. Introdução]$ _ [18/31]

43 >>> Design uma API O design de uma API RESTful para um blog: [1. Introdução]$ _ [19/31]

44 >>> Boas Práticas para APIs Um investimento em conhecimento sempre paga os melhores juros. (Benjamin Franklin) Nemeth [2017]. [2. Boas Práticas]$ _ [20/31]

45 >>> Métodos HTTP e Recursos da API Dicas! Uso de verbos HTTP: POST, PUT, GET, PATCH ou DELETE [2. Boas Práticas]$ _ [21/31]

46 >>> Métodos HTTP e Recursos da API Dicas! Uso de verbos HTTP: POST, PUT, GET, PATCH ou DELETE! Separar a API em recursos semânticos [2. Boas Práticas]$ _ [21/31]

47 >>> Métodos HTTP e Recursos da API Dicas! Uso de verbos HTTP: POST, PUT, GET, PATCH ou DELETE! Separar a API em recursos semânticos! Seguir padrão no uso dos verbos e nomes de recursos [2. Boas Práticas]$ _ [21/31]

48 >>> Métodos HTTP e Recursos da API Dicas! Uso de verbos HTTP: POST, PUT, GET, PATCH ou DELETE! Separar a API em recursos semânticos! Seguir padrão no uso dos verbos e nomes de recursos! As versões da API podem ser passadas na url ou no cabeçalho da requisição [2. Boas Práticas]$ _ [21/31]

49 >>> Métodos HTTP e Recursos da API Dicas! Uso de verbos HTTP: POST, PUT, GET, PATCH ou DELETE! Separar a API em recursos semânticos! Seguir padrão no uso dos verbos e nomes de recursos! As versões da API podem ser passadas na url ou no cabeçalho da requisição Cuidados % Não usar verbos para identificar recursos da API [2. Boas Práticas]$ _ [21/31]

50 >>> Métodos HTTP e Recursos da API Dicas! Uso de verbos HTTP: POST, PUT, GET, PATCH ou DELETE! Separar a API em recursos semânticos! Seguir padrão no uso dos verbos e nomes de recursos! As versões da API podem ser passadas na url ou no cabeçalho da requisição Cuidados % Não usar verbos para identificar recursos da API % Não há regra que diga se o recurso deve estar no singular ou plural [2. Boas Práticas]$ _ [21/31]

51 >>> Códigos de Status HTTP O uso correto do código de status HTTP 1 resposta. Códigos deve ser enviado como * 2xx: Se tudo ocorreu bem * 3xx: Se o recurso foi movido * 4xx: Se a requisição não pode ser completada por um erro do cliente (ex: recurso não existe) * 5xx: Se algo ocorreu no lado da API (ex: exceções) 1 [2. Boas Práticas]$ _ [22/31]

52 >>> Cabeçalhos HTTP Anexar metadados sobre as requisições que serão enviadas no cabeçalho HTTP 2 Dicas! Paginação! Autenticação 2 [2. Boas Práticas]$ _ [23/31]

53 >>> Escolha do Framework O framework deve estar de acordo com as necessidades da API: Figura: Frameworks Node.js [2. Boas Práticas]$ _ [24/31]

54 >>> Restify Usado em:! npm 3! Netflix [2. Boas Práticas]$ _ [25/31]

55 >>> Documentação da API Projetos para Documentação * APIDOC 5 * API Blueprint 6 * Swagger [2. Boas Práticas]$ _ [26/31]

56 >>> APIs para Inspiração Projetos para Documentação * Github 8 * Digital Ocean 9 * Stripe 10 * Iugu [2. Boas Práticas]$ _ [27/31]

57 >>> Hands-on [3. Hands-on]$ _ [28/31]

58 >>> Ambiente Criação de ambiente npm e nodejs $ curl -sl sudo -E bash - $ sudo apt-get install -y nodejs Curl $ sudo apt-get install curl Postman Baixar em site oficial [3. Hands-on]$ _ [29/31]

59 Hora de Codificação!

60 >>> Referências G. Nemeth. 10 best practices for writing node.js rest apis best-practices-for-writing-node-js-rest-apis/, Accessed: [5. Referências]$ _ [31/31]