O que é REST API e como você pode obter dados para seu aplicativo ou site?

A sigla API significa interface de programação de aplicativo. Um API é um conjunto de funções que facilita a comunicação entre dois aplicativos de software. Essencialmente, um API leva uma solicitação de um aplicativo de software para outro e, em seguida, retorna ao software inicial com uma resposta relevante.

DESCANSO significa transferência de estado representacional e é uma arquitetura usada para projetar aplicativos cliente-servidor. Com um API Rest, você está recebendo uma representação dos dados solicitados armazenados em um banco de dados. UMA API REST também não tem estado, o que significa que o servidor não armazena nenhum dado entre as solicitações dos clientes.

Se você está procurando um API Rest exemplo e uma explicação detalhada de como funciona, continue lendo.

Como funciona uma API REST?

UMA API REST acessa dados por meio de identificadores uniformes de recursos (URIs), que é uma sequência de caracteres que identifica um recurso específico. O tipo de URI usado por um API REST é um localizador uniforme de recursos (URL).

Para acessar e manipular recursos, um REST API usa os seguintes verbos de solicitação:

• Get (usado para adquirir dados de um banco de dados)
• Publicar (adicionar novos dados a um banco de dados)
• Colocar (atualizar os dados em um banco de dados)
• Excluir (excluir dados de um banco de dados)

Se você deseja utilizar os serviços de um dos muitos APIs REST disponível na web (em vez de construir um do zero), você só terá acesso ao verbo get request do API REST (por meio de um URL). Esses URLs têm vários componentes, mas os que você precisa saber são os API chave e a consulta.

o API chave é um identificador único, que você receberá assim que se registrar em um API REST plataforma. A consulta geralmente é uma equação simples usada para personalizar sua pesquisa. Portanto, se você deseja obter o clima atual na cidade de Nova York, a seção de consulta do seu URL pode ser “cidade = Nova York”.

Executar uma solicitação get retorna uma resposta, que contém um código de status e um corpo. Se a solicitação for bem-sucedida, o corpo da sua resposta conterá os dados que você deseja usar no seu site ou aplicativo.

Usando um aplicativo JavaScript para coletar dados de diferentes APIs Rest

Para construir este aplicativo simples, existem dois outros aplicativos de software que você precisa instalar no seu computador: NodeJS e npm. Escrevemos um artigo sobre como instalar NodeJS e npm no Ubuntu, bem como um em como fazer isso no Windows—Então verifique-os se quiser saber mais.

Depois que os aplicativos acima forem instalados em seu computador, você precisará realizar as seguintes etapas:

1. Abra seu IDE e inicie o terminal.
2. Navegue até a pasta que contém o arquivo do aplicativo JavaScript usando o comando cd.
3. Inicialize o npm com a seguinte linha de código:

npm init -y

Há um módulo npm que desempenhará um papel fundamental na funcionalidade deste aplicativo. Este é o módulo obtido, que é uma biblioteca de solicitação HTTP para NodeJS. A linha de código a seguir instalará a versão mais recente da biblioteca obtida nos arquivos do seu aplicativo:

npm install obteve @ mais recente

Agora você pode ir em frente e construir seu aplicativo.

Usando a Got Library para construir seu aplicativo

// importe a biblioteca obtida em seu aplicativo
const got = require ('got');
// busca dados de uma API REST específica e imprime seu corpo no terminal
(assíncrono () => {
Experimente {
resposta const = espera obtida (URL);
dados const = JSON.parse (resposta.body);
console.log (dados);
} catch (erro) {
console.log (error.data);
}
})();

O aplicativo acima irá obter dados de qualquer API REST Na internet. No entanto, você precisará fornecer o URL do recurso relevante primeiro.

Obtendo dados de uma API REST do tempo

The Weatherbit.io API é um dos climas mais populares APIs REST. Inserindo o URL deste API no aplicativo JavaScript simples acima tornará o aplicativo operacional.

Usando a API REST Weatherbit.io

// importe a biblioteca obtida em seu aplicativo
const got = require ('got');
// busca dados de uma API REST específica e imprime seu corpo no terminal
(assíncrono () => {
Experimente {
const URL = ' https://api.weatherbit.io/v2.0/current? lat = 40.7128 & lon = -74.0060 & key = API_KEY ';
resposta const = espera obtida (URL);
dados const = JSON.parse (resposta.body);
console.log (dados);
} catch (erro) {
console.log (error.data);
}
})();

O URL do Weatherbit.io API agora foi inserido com sucesso no aplicativo. No entanto, há um aspecto da URL que você precisa ajustar para colocar o aplicativo em execução. Esta é a seção chamada “API_KEY”, e esta chave é o que você receberá do Weatherbit.io quando se registrar para uma conta gratuita.

Você também tem a opção de ajustar a seção de consulta no código acima. O aplicativo está atualmente pesquisando o tempo na latitude de 40,7128 e na longitude de -74,0060, mas você pode inserir novas coordenadas. Embora a consulta acima seja a abordagem recomendada, você pode pesquisar o clima em um local usando o nome da cidade.

Para obter mais informações sobre como usar o Weatherbit.io API REST, Clique aqui.

Depois de inserir o seu API chave na seção relevante acima, agora você pode executar seu arquivo JavaScript. O aplicativo fornecerá algo semelhante à seguinte saída em seu terminal.

Weatherbit.io REST API Exemplo de resposta

dados: [
{
rh: 53,
pod: 'd',
lon: -74,01,
pres: 1005,9,
fuso horário: 'America / New_York',
ob_time: '2021-09-27 14:50',
country_code: 'US',
nuvens: 25,
ts: 1632754200,
solar_rad: 652,8,
state_code: 'NY',
city_name: 'New York City',
wind_spd: 5,66,
wind_cdir_full: 'oeste-sudoeste',
wind_cdir: 'WSW',
slp: 1015,9,
vis: 5,
h_angle: -30,
pôr do sol: '22: 44 ',
dni: 851,72,
dewpt: 12,
neve: 0,
uv: 5,68859,
precip: 0,
wind_dir: 240,
nascer do sol: '10: 49 ',
ghi: 657,55,
dhi: 106,79,
aqi: 53,
lat: 40,71,
clima: [Objeto],
datetime: '2021-09-27: 14',
temp: 22,
estação: 'KJRB',
ângulo_elev: 40,89,
app_temp: 21.7
}
],
contagem: 1
}

Alguns dos aspectos mais importantes dos dados retornados na resposta incluem:

• Nome da Cidade (retorna o nome da cidade na longitude e latitude fornecidas).
• Data hora (retorna a hora do ciclo atual no formato AAAA-MM-DD: HH).
• Clima (retorna um objeto contendo um ícone de clima, código de clima e uma descrição de texto do clima).

Obtendo dados de uma API REST de notícias

As notícias API usado nesta seção é Newsdata.io. Como todos APIs REST na web, ele fornece várias opções de consulta, que você pode usar para recuperar as notícias de última hora de todo o mundo. Com o Newsdata.io API, você pode obter notícias de um país específico ou em um determinado idioma, categoria e assim por diante.

Usando o aplicativo JavaScript, você pode recuperar dados de notícias API REST. Basta substituir o URL no aplicativo acima pelo seguinte URL:

' https://newsdata.io/api/1/news? apikey = YOUR_API_KEY & country = us '

A próxima etapa é substituir a seção “YOUR_API_KEY” no URL acima pelo API chave que você receberá após se registrar no Newsdata.io. O URL acima retornará notícias de última hora da América. No entanto, se você deseja notícias do Japão, pode simplesmente substituir a consulta “contry = us” por “country = jp”.

Para obter mais informações sobre como usar o Newsdata.io API REST, Clique aqui.

Relacionado: Quer adicionar manchetes de notícias ao seu site ou aplicativo? Você precisa da API Mediastack

Exemplo de resposta da API REST Newsdata.io

{
título: 'Motorista morto pela porta do próprio carro enquanto esperava na fila no Fast-Food Drive-Thru, fornecendo informações preventivas para carros com auto-direção com IA',
ligação: ' https://www.forbes.com/sites/lanceeliot/2021/09/27/driver-killed-by-his-own-car-door-while-waiting-in-line-at-fast-food-drive-thru-providing-cautionary-insights-for-ai-self-driving-cars/',
palavras-chave: [Array],
criador: [Array],
video_URL: null,
descrição: "Notícia triste sobre um motorista que foi morto pela porta de seu próprio carro (enquanto em um drive-thru), fornece insights de advertência sobre
o advento dos carros autônomos baseados em IA. Aqui está o visual interno. ",
conteúdo: "Uma triste notícia sobre um motorista que foi morto pela porta de seu próprio carro (enquanto estava em um drive-thru), fornece insights de advertência sobre o
advento de carros autônomos baseados em IA. Aqui está o visual interno. ",
pubDate: '2021-09-27 15:30:00',
imagem URL: ' https://thumbor.forbes.com/thumbor/fit-in/0x0/filters%3Aformat%28jpg%29/https://specials-images.forbesimg.com/imageserve/614272b9f18bec6882652695/0x0.jpg? cropX1 = 23 & cropX2 = 2455 & cropY1 = 23 & cropY2 = 1538 ',
source_id: 'forbes'
}

Usando um aplicativo Python para coletar dados de diferentes APIs Rest

É possível obter dados para seu site ou aplicativo usando qualquer linguagem de programação com a qual você esteja familiarizado. Portanto, se você não quiser usar JavaScript, poderá obter os mesmos resultados com um aplicativo Python.

Relacionado: Como construir APIs em Python: estruturas populares

Tudo o que você precisa fazer é instalar o módulo Python HTTP de solicitações usando o ambiente pip. Em seguida, você pode construir seu aplicativo Python usando o seguinte código:

# importar a biblioteca de solicitações
pedidos de importação
# pegando dados usando a biblioteca de solicitações
URL = ' https://newsdata.io/api/1/sources? apikey = YOUR_API_KEY = us '
res = requests.get (URL)
json = res.json ()
para chave em json:
imprimir (chave, json [chave])

Semelhante aos exemplos anteriores, você precisará inserir seu API chave na seção relevante. Você receberá os mesmos dados que o aplicativo JavaScript retorna.

Obter dados para seu site ou aplicativo é muito simples

Agora você tem as ferramentas de que precisa para obter dados para seus aplicativos de software. É importante lembrar que o DESCANSO arquitetura facilita o acoplamento fraco, o que significa que você pode usar qualquer linguagem de programação para obter dados de qualquer API REST Na internet.

Agora você sabe como usar API Rest, por que não tentar?

Web Scraping vs. API: Qual é a melhor maneira de extrair dados?

Há dados em todos os lugares, mas colocar as mãos neles é outro problema - se é que é legal.

Leia a seguir

Sobre o autor