/on19-tet-s8-api-II

Introdução à API: GET + POST // Servidor, Endpoints, Rotas, Status Code, curl, postman

Primary LanguageJavaScript

Tema da Aula

Turma Online 19 - Todas em Tech | Back-end | Semana 8 | 2022 | Professora Manuelly Suzik

Instruções

Antes de começar, vamos organizar nosso setup.

  • Fork esse repositório
  • Clone o fork na sua máquina (Para isso basta abrir o seu terminal e digitar git clone url-do-seu-repositorio-forkado)
  • Entre na pasta do seu repositório (Para isso basta abrir o seu terminal e digitar cd nome-do-seu-repositorio-forkado)

Resumo

O que veremos na aula de hoje?

Conteúdo

Introdução a API

  1. O que é API
    • Application Programming Interface: literalmente significa que é uma interface de programação para aplicações. Na prática, API's foram criadas para facilitar a troca de informações entre os clients e o sistema / serviço / dispositivo e etc. O funcionamento consiste em a API receber requisições de um client qualquer e responder em um formato que o client consiga interpretar.Assim, o client consegue ter acesso as informações para utiliza-las.
  2. REST e SOAP
    1. REST(Representational state transfer): Um modelo relativamente novo ( e mais utilizado ) de comunicação de construção de API. É representado pelas convenções / princípios / regras de métodos HTTP e formato de resposta, normalmente em JSON( Javascript Object Notation ).
    2. SOAP(Simple object access protocol): Uma forma mais antiga de construir API's, utiliza como resposta documentos XML. Com padrões de comunicação e regras diferentes.

Servidores, Endpoints, Rotas , Status Codes, Métodos HTTP e POSTMAN

  1. Servidores Os servidores é um conceito dado a onde as aplicações ficam armazenadas e são executadas. De uma maneira simples, o servidor é um computador que está hospedado em algum lugar do mundo e que pode ser acessado pela internet. Esses servidores são máquinas dedicadas apenas para rodar suas aplicações , você pode contratar servidores pelo seu desempenho e armazenamento dependendo da sua necessidade.
  2. Status Codes Os Http status codes são números que representam o status da resposta da sua requisição foi completada com sucesso ou não. O status code também informa a fonte do erro a partir do número que foi enviado e segue a seguinte convenção:
    • Information Codes - 1XX: Compoem códigos de resposta para informações, não é comumente utilizado.
    • Client Codes - 4XX: Status codes que começam com 4 indicam que a fonte do erro foi causada pelo cliente. (Ex.: Formulário preenchido com valores inválidos , páginas não encontradas , endereço solicitado não encontrado , falta de autorização...)
    • Server Codes - 5XX: Status code que começam com o 5 indicam que o erro surgiu por parte do servidor (Ex.: Falta de memória , queda de conexão com o servidor, manutenção...)
    • Success Codes - 2XX: Status code iniciados com o 2 mostra que a resposta à sua requisição ao servidor foi um sucesso. Os mais comuns são o de Sucesso (200) e Criado (201).
    • Redirect Codes 3XX - Normalmente não são muito utilizados no modelo REST mas esses status codes avisam se sua requisição de origem foi redirecionada para outro endereço.
  3. Rotas e Endpoints
    • As rotas são endereços de acessos à recursos da API , por exemplo: vá até o google e perceba que na página inicial o endereço é apenas https://www.google.com/ mas se clicarmos para buscar algo o endereço muda, ele terá esse formato: https://www.google.com/search? ... o /search é o recurso que estamos acessando do google ( no caso a busca ) e o que vem depois do ? são dados para refinar o resultado de sua busca no google. Essa URL completa com os refinamentos damos o nome de endpoint.
  4. HTTP CLIENTS

Métodos HTTP: GET + POST

Esse curso seguirá a convenção de comunicação API RESTful

Exercícios

Material da aula

Links Úteis

Desenvolvido com 💜