Complexo Girassol

Professor: Cedrick Mansoni

 Complexo Girassol
Professor: Cedrick Mansoni

O que é API ?
API nada mais é do que uma forma de
comunicação entre sistemas. Elas permitem
a integração entre dois sistemas, em que
um deles fornece informações e serviços
que podem ser utilizados pelo outro, sem a
necessidade do sistema que consome a API
conhecer detalhes de implementação do
software
Complexo Girassol
Professor: Cedrick Mansoni
 Complexo Girassol
Professor: Cedrick Mansoni
Métodos de solicitação

O protocolo HTTP define oito métodos (GET, HEAD, POST, PUT,

DELETE, TRACE, OPTIONS e CONNECT) que indicam a ação a ser
realizada no recurso especificado. Os métodos determinam o que o
servidor deve fazer com o URL fornecido no momento da requisição
de um recurso. Um servidor HTTP deve implementar ao menos os
métodos GET e HEAD. Os métodos GET e POST são os que aparecem
mais comumente durante o desenvolvimento web.
Uma solicitação HTTP, ou HTTP Request é uma maneira
do navegador mostrar uma página da internet utilizando um dos
oito métodos de solicitação do protocolo HTTP.
 Complexo Girassol
Professor: Cedrick Mansoni
GET
O método GET requisita uma representação do recurso
especificado. Requisições usando GET devem apenas recuperar
dados e não devem ter qualquer outro efeito.

POST
Envia dados para serem processados (por exemplo, dados de um
formulário HTML) para o recurso especificado. Os dados são
incluídos no corpo do comando. Sua utilização em uma
requisição ocorre quando é necessário enviar dados ao servidor
para serem processados.
 Complexo Girassol
Professor: Cedrick Mansoni

PUT
O método PUT envia os dados de forma semelhante ao POST,
através do corpo do HTTP a diferença entre os 2 métodos é
semântica. Por exemplo:
Caso você necessite actualizar os dados de um usuário,
utilizando o método PUT você pode atualizar diversas vezes,
pois o PUT vai sobrescrever os dados com isso ficará somente
com um único registro atualizado.
DELETE
Quando é necessário a destruição de um recurso existente, o
método DELETE deverá ser utilizado. Opcionalmente poderá ser
retornado ao cliente um código de confirmação da remoção ou
erro, embora o não-retorno, em caso de sucesso, seja
perfeitamente aceitável
 Recebe dados Insere dados Actualiza dados Remove dados

Complexo Girassol
Professor: Cedrick Mansoni
 Complexo Girassol
Professor: Cedrick Mansoni
Códigos de estado

A primeira linha da resposta HTTP é chamada linha de estado e inclui um código de

estado numérico (como "404") e uma frase de razão textual (como "Not Found" - Não
Encontrado). A maneira que o agente de usuário manipula a resposta depende
primeiramente do código e secundariamente nos cabeçalhos de resposta. Códigos de
estado personalizados podem ser usados, uma vez que, se o agente de usuário encontrar
um código que ele não reconheça, ele pode usar o primeiro dígito do código para
determinar a classe geral da resposta.

Da mesma forma, as frases de razão padrões são apenas recomendações e podem ser
substituídas com "equivalentes locais" a critério do desenvolvedor web. Se o código
de estado indicou um problema, o agente de usuário pode mostrar a frase de razão para
o usuário, para que sejam fornecidas informações adicionais sobre a natureza do
problema. O padrão também permite que o agente de usuário tente interpretar a frase
de razão, apesar disto poder ser imprudente uma vez que o padrão especifica
explicitamente que os códigos de estado são legíveis por máquina e as frases de razão
são legíveis por homens.
 Complexo Girassol
Professor: Cedrick Mansoni

Ao realizar uma requisição para o servidor é retornado um

código de status, um número de três dígitos, que resume a
resposta enviada pelo servidor e auxilia aos clientes na
interpretação. Esses códigos são divididos em cinco famílias:
1xx, 2xx, 3xx, 4xx e 5xx, sendo:

• 1XX - Informacionais;
• 2XX - Códigos de sucesso;
• 3XX - Códigos de redireccionamento;
• 4XX - Erros causados pelo cliente;
• 5XX - Erros originados no servidor.
Complexo Girassol
Professor: Cedrick Mansoni
Complexo Girassol
Professor: Cedrick Mansoni
 Complexo Girassol
Professor: Cedrick Mansoni

Ferramentas necessárias
Complexo Girassol
Professor: Cedrick Mansoni
 Complexo Girassol
Projecto API Professor: Cedrick Mansoni

1º Cria uma pasta no ambiente de trabalho com o nome de api(o nome é opcional);

2º Abra essa pasta, e dentro dela clique com o botão direito do mouse, e escolha a
opção abrir com Code.
 Complexo Girassol
Projecto API Professor: Cedrick Mansoni

OBS: Se não tiver a opção de abrir com o Code, podem abrir o cmd;

Digite as linhas acima para chegar até a

pasta api, e abri-la com vscode
3ºAgora vamos criar o projecto webapi, digitando no cmd o seguinte comando:
dotnet new webapi e pressione a tecla enter.

OBS: Também podemos aplicar esses comandos dentro do terminal do vscode.

 Complexo Girassol
Professor: Cedrick Mansoni

Projecto API

4º Por padrão este projecto já vem com um

arquivo denominado “WeatherForecast.cs”.
Podemos excluir este arquivo e seu respectivo
Controlador.
Projecto API

5º Vamos criar a pasta Model e dentro três classes denominadas Pessoa, PessoaFisica e
PessoaJuridica:
7º Vamos definir algumas propriedades para a class Pessoa.
8º Agora as classes PessoaFisica e PessoaJuridica precisam herdar as propriedades da
classe Pessoa.
9º Agora vamos definir as propriedades das classes PessoaFisica e PessoaJuridica.
10º Agora vamos criar um controlador da PessoaFisica denominada PessoaFisicaController.
11º Agora vamos importar a biblioteca (1)Microsoft.AspNetCore.Mvc, (2)indicar a partir de
um data anotation que a classe é uma apicontroller, (3)definir a rota(endpoint), (4)herdar
propriedades da classe ControllerBase e (5)criar um método para consultar dados(HttpGet).

2 4
3