web api youtube

Page 1

O QUE É API

api é uma interface de comunicação. Interface é a camada de interação entre o usuario e o sistema. a api se comunica com outros sistemas. As apis trafegam informações no formato Json (geralmente). Não é uma regra que a rest api funcione com o http. Porem, é o que acontece em 90% dos casos.

PROTOCOLO HTTP:

é um protocolo web, composto de verbos (GET, POST, DELETE, PUT, PATCH) entre outros. esses verbos dizem o que se faz em determinado endereço. o protocolo tem uma url que é o endereço de algo, tem parametros de entrada, que seria as query string, que vão fazer uma especie de filtro, tem uma mensagem de request(um body) que pode ser enviado pelo progamador. Também tem uma mensagem de resposta, uma response. Também há os headers, que são informações de controle, que podem acomapnhar a requisição. No swagger, é o curl que faz esse papel.

HEADER

define o que o usuario esta requisitando e o que o servidor está devolvendo

CARACTERISTICAS DA REST

a api rest não armazena os dados da sua requisição. ela executa no momento que a requisição é feita, portanto, não tem historico.

RECURSOS

são representações das coisas que existem no mundo real.

ENDEREÇAMENTO DE API

(imagem la embaixo)

base path: é o endereço do servidor onde o recurso se encontra e depois do endereço, tem os recursos em si.

VERBOS HTTP:

eles não causam nenhuma alteração no servidor (post é uma exceção), portanto, são caracterizados como seguros. Independentemente de quantas vezes eu chamar o meu verbo, Independentemente de quantas vezes eu fizer a minha requisição, ele vai me gerar o mesmo resultado. isso possibilta que caso aconteça um erro, de pra chamar novamente e se ter o resultado desejado.

POST

é comum esperar de retorno de um post a resposta 201, que afirma que foi adicionado algo (created). O servidor faz um id que indica o "numero" do meu post.

CODIGOS DE RETORNO

indicam sucesso ou insucesso no processamento da requisição enviada ao servidor.

Panoramas gerais de api

uma requisição por completo é composta de: headers (informação sobre quem solicitou e o que o servidor devolveu), a url, que é pra onde vai aquela requisição (pra qual servidor), há também o complemento: query strings: A query string é uma sequência de caracteres que é anexada ao final de uma URL. Ela é usada para transmitir informações adicionais para o servidor, como parâmetros de consulta ou dados de formulário1. Basicamente, a query string é composta por uma série de pares chave-valor, separados por “&”, que são adicionados à URL de uma página da web. Esses pares chave-valor permitem transmitir informações específicas para o servidor, que pode processá-las e retornar os resultados desejados. Por exemplo, em uma URL como “www.exemplo.com/pagina?chave1=valor1&chave2=valor2”, a query string contém duas chaves (chave1 e chave2) e seus respectivos valores (valor1 e valor2), pode ter um header e o verbo (get,post,etc).

também há o body, onde inserimos a requisição de fato.

O QUE ACONTECE QUANDO O REQUEST CHEGA NO SERVIDOR?

Ao chegar no servidor, acontece o processamento, ele responde no endereço, na url, pra onde o request foi enviado, ele interpreta a mensagem, valida os campos de entrada. depois disso, ele pode fazer uma consulta ou alteração de estado, onde fica os recursos daquele negocio. depois disso, ele define uma representação do retorno daquela mensagem (json por exemplo)

o cliente recebe o que é chamado de mensagem de retorno (response), que também contem um header elacionado aquela resposta, um status code e um body com a resposta.

PULLING

quando há uma chamada assincrona, e você quer checar como está o estado da sua solicitação, você faz um request ao servidor pedindo informações daquela solicitação. Isso se chama pulling, e pode ate usar um metodo TCC que vai definir de quanto em quanto tempo essas requisições serão realizadas. Porem, seria melhor realizar outro metodo. pode se definir uma url onde o servidor ficara alocado enquanto está cumprindo a requisição e naquele momento em que acabar, ele retornará o valor. porem, nesse caso, é necessário que o usuario tenha um lugar para alocar.

QUERY STRINGS:

é um conjunto de chave valor que ficam presentes na url da api. Eles iniciam com interrogação e são separados por um sinal de igual. Nesse caso, uma query string é utilizada para filtrar melhor a informação que se quer ter. Por exemplo: se voce tem um objeto e quer algo especifico que está dentro dele, se usa as query strings. exemplo:

usuarios?signo=sagitario

nesse codigo, usuario é nosso objeto e nossa query string é o ?signo=sagitario. Com isso quero dizer que dentro de usuario quero o signo sagitario. se houver mais de um atributo do qual queremos obter informação, é so concatenar com o &.

quando queremos pesquisar por intervalos, entre uma query e outra, pode se usar o from e o to.

HATEOAS

quando uma requisição é feita e o valor é retornado, ele te fornece opções adicionais de verbos.