Desenvolvimento de APIs
Role para baixo
Para Começar
Este material aborda conceitos relacionados a Desenvolvimento de APIs.
Esperamos que você desenvolva, no decorrer de seus estudos, as seguintes capacidades:
- Desenvolver a API do aplicativo, disponibilizando os recursos para leitura, escrita, atualização e deleção do projeto.
- Restringir o acesso aos recursos da API aos usuários autenticados, visando a integridade e segurança da informação.
Para desenvolver tais capacidades, você deverá estudar os seguintes temas:
- Métodos de requisição HTTP.
- Padrão Model View Control (MVC).
- API.
- Linguagem de programação para APIs.
O estudo desses temas será necessário para que você resolva a situação-problema a seguir. Então, avance para conhecê-la.
Situação-Problema
A ExoApi é uma empresa de desenvolvimento de software focada na integração entre diferentes sistemas, softwares ou serviços. Utiliza as tecnologias mais recentes do mercado para ter performance, controle, segurança e escalabilidade para sua empresa e seus contratantes.
A ExoApi contratou você para desenvolver a nova demanda que será realizada para o lançamento de seu novo aplicativo. O aplicativo consiste em armazenar todos os projetos que a empresa realiza para ter maior controle e melhorar a gestão e visibilidade do que está sendo feito por seus funcionários.
Essa demanda consiste em desenvolver a interface (API) para disponibilizar os dados que serão apresentados e utilizados pela equipe de mobile e exige os seguintes critérios:
- Ler todos os projetos (título, status, data de início, tecnologias/requisitos/área);
- Buscar informações somente de um projeto;
- Deletar um projeto;
- Atualizar todas as informações de um projeto ou somente uma informação específica;
- Disponibilizar a documentação da API;
- Retornar os status de respostas corretos de acordo com as melhores práticas;
- Retornar os dados em formato JSON;
- Utilizar frameworks para a criação de API;
- Disponibilizar o recurso de deletar um projeto, somente para usuários que possuem permissão;
Para concluir esse projeto, você deverá solucionar os seguintes desafios.
Clique nos botões a seguir para conhecê-los:
Desafio 1
Desenvolver a API do aplicativo, disponibilizando os recursos para leitura, escrita, atualização e deleção do projeto.
Desafio 2
Restringir o acesso aos recursos da API aos usuários autenticados, visando a integridade e segurança da informação.
Desafio 1
Nesta etapa, você deverá resolver o desafio 1:
- Desenvolver a API do aplicativo, disponibilizando os recursos para leitura, escrita, atualização e deleção do projeto.
Para isso, você estudará os seguintes conteúdos:
- Métodos de requisição HTTP.
- Get, Put, Post, Patch, Delete.
- Padrão Model View Control (MVC).
- Organização de arquitetura de sistemas.
- API.
- Definição.
- Formatos.
- Aplicação.
- Protocolo de comunicação.
- Metodologias ágeis para desenvolvimento de APIs.
- Linguagem de programação para APIs.
- Funcionalidades para APIs.
- Técnicas de depuração.
- Documentação do sistema.
- Técnicas de programação e controle.
- Frameworks.
- Status de respostas.
- Tratamento de exceções.
- Técnicas de formato de comunicação.
- Formatos e requisição.
- XML.
- JSON.
Desenvolvimento de APIs
Clique no player a seguir para acessar o vídeo sobre o Desenvolvimento de APIs.
Pré-requisito e roteiro de configuração
Para este desafio será necessário realizar:
- Instalação do Visual Studio 2019.
- Instalação do SQL Server.
- Instalação do SSMS ou Azure Data Studio.
- Instalação do Insomnia ou Postman.
- Download do arquivo db.sql que contém as criações das tabelas do banco de dados que serão utilizadas durante o desenvolvimento do projeto.
Após a instalação das ferramentas mencionadas realize o passo a passo a seguir para iniciar o projeto.
Clique aqui para baixar o tutorial com o passo a passo.
A seguir vamos conhecer os seguintes tópicos:
- Protocolo HTTP focado em requisições e respostas;
- O que são API’s, REST, RESTful;
- Como construir API’s Web utilizando padrões de arquitetura.
É importante compreender como as solicitações na web são realizadas e quais protocolos e regras são utilizados.
Métodos de requisição http
O HTTP (Hypertext Transfer Protocol) é o protocolo que permite web servers e browsers enviarem e receberem informações e dados pela internet. É um protocolo de requisição e resposta, ou seja, o cliente faz a requisição e o servidor dá a resposta, conforme o exemplo a seguir:
Clique nas setas laterais para navegar pelo conteúdo.
No campo de pesquisa ou endereço digite http://sp.senai.br e depois pesquisar ou enter.
Ao realizar essa ação, o cliente (navegador web) faz uma solicitação (ou request) para o servidor responsável por esse endereço. O servidor realiza os procedimentos necessários e devolve uma resposta ao cliente (ou response). A informação recebida, geralmente um documento HTML será renderizado no navegador web e a resposta será apresentada.
Apresentação do site após o navegador renderizar as informações recebidas do servidor.
Requisições
Uma requisição (request) HTTP é realizada quando o usuário solicita uma informação ao servidor e tem a estrutura, conforme imagem a seguir:
A requisição está estrutura a partir da seguinte organização:
- Os métodos HTTP, também chamados de verbos, definem a ação que o usuário deseja realizar e cada um implementa uma semântica diferente.
- O método GET é utilizado para buscar um recurso e o método POST é utilizado para enviar uma informação em um formulário e alterar informações (como um usuário e senha).
- É um endereço virtual com um caminho que indica onde está o que o usuário procura, e pode ser tanto um arquivo, como uma máquina, uma página, um site, uma pasta etc. Um URL é composto de um protocolo, que pode ser tanto HTTP, que é um protocolo de comunicação, FTP (do inglês File Transfer Protocol ou Protocolo de Transferência de Arquivo), que é uma forma rápida de transferir arquivos na internet, entre outros.
- São as informações adicionais ao servidor que possui a estrutura em [uma cadeia de caracteres: valor].
- Versão do protocolo HTTP que será utilizado.
- Como enviar dados em um formulário HTML para serem processados pelo recurso especificado.
Respostas
A solicitação é a resposta do servidor sobre o estado do recurso solicitado, conforme a estrutura representada a seguir:
Essa estrutura apresenta: Status Code, Cabeçalho e Corpo da resposta.
O status que informa a resposta do servidor (se foi com sucesso, falha, erro, não encontrada). Para compreender as respostas dos status HTTP, os códigos podem ser agrupados em cinco classes:
1) Respostas de informação (100-199);
2) Respostas de sucesso (200-299);
3) Redirecionamentos (300-399);
4) Erros do cliente (400-499);
5) Erros do servidor (500-599).
Para conhecer um exemplo de requisição, clique aqui.
Agora que conheceu na prática como são realizadas as requisições, vamos entender o que é API, REST e RESTfull.
API
A sigla API significa Application Programming Interface (interface de programação de aplicações). É uma interface que permite a comunicação entre um ou mais sistemas através de um conjunto de definições entre solicitante e produtor desse conteúdo, possibilitando que um sistema utilize as funcionalidades de outro sistema programaticamente.
Para exemplificar, imagine o exemplo de uma restaurante. O cliente (como uma página na web ou aplicativo móvel) solicita informações ao garçom (API), a partir da informação contida no menu, para fazer um pedido. O garçom leva esse pedido até a cozinha (server), que fica responsável por executar a ação solicitada. Você não tem a descrição, por exemplo, sobre como será feito o prato.
Tipos de APIs
Conforme você estudou, uma API é um conjunto de regras que permite diferentes programas se comunicarem para trocar dados e, a partir disso, executarem uma função conjunta. As APIs podem ser classificadas de acordo com o tipo de interoperabilidade que ocorre em uma aplicação.
Clique nas abas a seguir para conhecer alguns tipos de APIs.
Utilizadas internamente para as aplicações de uma empresa, ou seja, de maneira local, quando há a necessidade de restringir o acesso aos dados; por exemplo, em empresas de e-commerce.
Podem ser utilizadas livremente e ficam disponíveis gratuitamente para integração em qualquer projeto; por exemplo, Twitter e Facebook.
Utilizadas entre empresas parceiras de negócios; por exemplo, uma empresa de e-commerce e a transportadora que lhe presta serviço.Utilizadas entre empresas parceiras de negócios; por exemplo, uma empresa de e-commerce e a transportadora que lhe presta serviço.
, localizado ao lado da barra de endereço do navegador, ou pressione a tecla F5.
