Como funcionam as APIs de descanso

Como funcionam as APIs de descanso
APIs de descanso ou repouso estão em toda parte hoje em dia. Você pode ter usado mesmo sem saber nada sobre isso. Neste artigo, vou falar sobre APIs de descanso. Vou discutir como eles funcionam, suas aplicações e muito mais. Vamos começar.

Por que usar a API REST:

Em aplicativos da web tradicionais, digamos um servidor web PHP simples,

  • Você solicita uma página (digamos php) do servidor.
  • O servidor encontra o arquivo de script (php) correspondendo à página que você solicitou e começa a executá -la. O script se conecta ao banco de dados, procura as informações necessárias, coloca as informações na página de uma maneira bem formatada (misturando HTML + CSS + JavaScript com os dados) que parece muito atraente para o visitante.
  • Então o servidor o envia de volta ao visitante.

Neste modelo, todo o processamento é feito no lado do servidor. Portanto, o servidor tem que fazer mais trabalho. Aqui, os dados não são separados da página, são incorporados profundamente na página.

Se no futuro, você deseja criar um aplicativo Android ou um aplicativo iOS ou um aplicativo de desktop do seu site, você terá que fazer muito mais trabalho. Você terá que se conectar ao banco de dados diretamente de cada um desses aplicativos, o que pode não estar muito seguro. O tempo de desenvolvimento aumentará e os problemas de portabilidade surgirão.

Digamos que você tenha feito com sucesso os aplicativos desktop, Android e iOS do seu site. O nome completo do usuário é exibido em minúsculas em cada um deles. Agora, você gostaria de mostrá -lo em maiúsculas. Bem, os desenvolvedores precisam modificar a versão para desktop, Android e iOS do seu aplicativo separadamente para fazer isso. Que consome tempo. No mundo real, as coisas não serão tão simples quanto esta. Portanto, uma versão do aplicativo (digamos a versão da área de trabalho) pode ter um bug sério no processo de atualização. Consertar mais tarde levaria mais tempo. Você pode ver como o tempo de desenvolvimento aumenta? Esta solução também não é portátil.

Na API REST, você pergunta ao servidor da API o que você precisa e envia apenas as informações que você solicita, nenhuma formatação adicional é feita no servidor. Não há necessidade de processamento desnecessário no servidor. Portanto, o desempenho do seu site e aplicativos é naturalmente melhorado. Além disso, você pode usar os mesmos dados em seu site, aplicativos de desktop, aplicativos Android e iOS. Alterações feitas nos servidores serão refletidas nos aplicativos que estão usando a API. O tempo e o custo de desenvolvimento de aplicativos também serão reduzidos.

Como funcionam a API REST:

As APIs restantes têm pontos de extremidade. Um endpoint nada mais é do que um URL, mas de uma maneira bem formatada e é significativa. Ele usa as solicitações HTTP nativas (como PEGAR, PUBLICAR, COLOCAR, EXCLUIR etc) para decidir o que fazer quando você acessar cada terminal. Vou falar sobre isso mais tarde.

O formato de saída da API REST é JSON também conhecido como notação de objeto JavaScript.

Um exemplo da saída de um PEGAR solicitação para a API REST /usuários/id/12 O endpoint pode parecer o seguinte:


"ID": 12,
"Nome": "David Smith",
"Idade": 42,
"Telefones": ["124-211-2341", "889-211-4545"],
"país": "nós"

Como você pode ver, eu fiz um PEGAR solicitação em /usuários/id/12 endpoint para dizer à API REST para me fornecer informações sobre o usuário que tem o eu ia 12. Recebi apenas as informações que solicitei, nada mais, nada menos.

Agora, digamos, você deseja informações sobre os últimos 10 usuários que se inscreveram no seu site. Você pode fazer um PEGAR solicitação em /usuários/mais recente/10 endpoint.

Você pode adicionar novos dados no seu servidor usando a API REST também. Geralmente, o http PUBLICAR A solicitação é usada para pedir à API REST para adicionar novos dados ao servidor de API.

Por exemplo, você pode fazer um PUBLICAR solicitação em /Usuários endpoint com os dados do novo usuário e ele será adicionado ao banco de dados no seu servidor de API. Você também pode configurar sua API para retornar o status da solicitação.


"StatusCode": 400,
"Statustustext": "Usuário adicionado com sucesso.",
"dados":
"ID": 13,
"Nome": "Mary Smith",
"Idade": 35,
"Telefones": ["124-211-2341", "889-211-4545"],
"país": "nós"

Como você pode ver, o StatusCode e Statustext A propriedade do objeto JSON notifica o cliente da API de que o usuário é adicionado com sucesso. Os dados adicionados também são retornados no dados propriedade do objeto JSON. Você pode configurar sua API do jeito que você deseja.

Você também pode atualizar um registro existente do banco de dados do servidor da API. O COLOCAR A solicitação HTTP é usada em um endpoint da API para atualizar os dados existentes no banco de dados do seu servidor de API.

Por exemplo, digamos que você queira atualizar o número de telefone do usuário com o ID 13. Você pode fazer um COLOCAR Solicitação no terminal da API /usuário/id/13.


"StatusCode": 200,
"Statustustext": "Usuário atualizado.",
"Old_data":
"ID": 13,
"Nome": "Mary Smith",
"Idade": 35,
"Telefones": ["124-211-2341", "889-211-4545"],
"país": "nós"
,
"novos dados":
"ID": 13,
"Nome": "Mary Smith",
"Idade": 35,
"Telefones": ["100-211-1111", "140-211-1145"],
"país": "nós"

Como você pode ver, a operação de atualização é bem -sucedida. Os dados antigos e novos dados são retornados no Old_data e novos dados propriedade do objeto JSON, respectivamente.

Você também pode excluir dados do banco de dados do servidor da API com o HTTP EXCLUIR Solicitação no terminal da API.

Por exemplo, para excluir o usuário com o ID 12, você pode fazer um EXCLUIR Solicitação no terminal da API /usuário/id/12.


"StatusCode": 150,
"Statustustext": "Usuário removido.",
"dados":
"ID": 12,
"Nome": "David Smith",
"Idade": 42,
"Telefones": ["124-211-2341", "889-211-4545"],
"país": "nós"

Como você pode ver, o usuário é excluído e os dados excluídos do usuário são retornados no dados propriedade do objeto JSON.

Eu expliquei a maneira padrão de usar o PEGAR, PUBLICAR, COLOCAR e EXCLUIR Solicitação HTTP nos pontos de extremidade da API para fazer CRUD (Criar, ler, atualizar e excluir) Operação usando API REST. Mas você pode configurar sua API para fazer certas coisas em determinada solicitação HTTP. Nada está consertado aqui. Por exemplo, você pode atualizar a API usando PEGAR Solicitação http. Você não tem que usar COLOCAR. Cabe ao designer de API.

Você projeta os pontos de extremidade da API também. Dar nomes significativos aos seus pontos de extremidade da API facilita muito o uso da sua API de descanso.

Aplicações da API REST:

APIs tornam o desenvolvimento de aplicativos mais fácil e modular. Com a ajuda da API REST, você pode portar seu aplicativo facilmente para diferentes plataformas.

Tudo o que você precisa fazer é projetar e desenvolver uma API REST do seu aplicativo. Em seguida, você pode usar sua API REST do seu site, aplicativo Android, aplicativo iOS, aplicativo Windows Desktop e Linux etc. Dessa forma, todos os seus aplicativos em diferentes plataformas usarão a mesma lógica e seu tempo e custo de desenvolvimento serão reduzidos. Os aplicativos serão mais fáceis de gerenciar também. As APIs de REST são usadas rapidamente em aplicativos da Web de página única hoje em dia também.

Eu escrevi um artigo sobre escrita APIs REST usando Python. Obrigado por ler este artigo.