Este artigo mostrará como trabalhar com APIs em nossa plataforma sem código de nível profissional, AppMaster.io. Mas, primeiro, vamos lembrá-lo de algumas informações básicas sobre a API.
Introdução
API significa Interface de Programação de Aplicativos. É assim que o cliente e o servidor podem se comunicar. O cliente e o servidor enviam solicitações e respostas, e a API atua como intermediária entre eles.
Essa interação cliente-servidor deve ser simples, compreensível e conveniente. Ele simplifica tanto as tarefas dos desenvolvedores (não há necessidade de reinventar um novo serviço) quanto os usuários (um serviço é mais fácil de aprender se funcionar com familiaridade). Existem vários tipos de API:
- APIs de serviço da Web, XML-RPC e JSON-RPC, SOAP;
- APIs de WebSockets;
- APIs baseadas em biblioteca, Java Script;
- APIs baseadas em classe, API C#, Java.
Na plataforma AppMaster.io sem código, usamos o estilo da API REST.
REST ou toda a Representational State Transfer é o estilo arquitetônico de interação (troca de informações) entre o cliente e o servidor. Os serviços na API REST se comunicam usando o protocolo HTTP.
O estilo REST tem certas vantagens. A principal vantagem do REST é a excelente flexibilidade. REST consiste em diretrizes simples, permitindo que os desenvolvedores implementem requisitos em seu formato. O REST possui alto desempenho, o que é muito importante, por exemplo, para carregamento rápido em dispositivos móveis. É por isso que todas as grandes empresas, como Twitter e Google, há muito tempo implementam a API REST para seus produtos. Você pode ler mais sobre o trabalho e as principais vantagens da API REST em nosso artigo.
A estrutura de qualquer solicitação inclui cinco componentes principais: método HTTP, endpoints, cabeçalhos e corpo, parâmetros de solicitação.
A API REST usa 4 métodos HTTP básicos para trabalhar com um recurso (informações), e cada um deles descreve o que deve ser feito com o recurso:
- POST — criação de recursos;
- GET — obtendo um recurso;
- PUT — atualização de recursos;
- DELETE — excluindo um recurso.
Um recurso é qualquer informação (documento, imagem, vídeo, texto e assim por diante). Na plataforma sem código AppMaster.io, essas informações são entregues ao cliente em vários formatos, incluindo o mais comum — JSON.
O endpoint contém um URI — Uniform Resource Identifier (identificador uniforme de recursos), que indica onde e como encontrar um recurso na Internet e inclui um URL (URL ou Uniform Resource Location é um endereço web completo).
Os cabeçalhos transmitem informações tanto para o cliente quanto para o servidor. Os cabeçalhos fornecem principalmente dados de autenticação: uma chave de API, o nome ou endereço IP do computador no qual o servidor está instalado e o formato de resposta.
O corpo é necessário para passar informações adicionais ao servidor: dados do corpo são dados que você, por exemplo, deseja adicionar ou substituir.
A documentação da API do seu aplicativo em nossa plataforma é gerada automaticamente e armazenada no formato OpenAPI (Swagger) em seu backend.
Você não precisa entender exatamente como funciona para aprender a construir uma API no AppMaster.io. Você entenderá os princípios básicos aprendendo sobre as ferramentas da plataforma. Além disso, a parte central da API é criada pelo AppMaster.io. A maioria das configurações é feita por padrão ou ao conectar módulos. Por exemplo, nosso módulo fornece ferramentas para integração com APIs para e-mail.
Você precisará fazer pequenas alterações em algumas configurações de API manualmente ao integrar (conectar) seu aplicativo a outros aplicativos ou recursos externos. A seguir, veremos como fazer isso.
Criação de API usando a plataforma sem código AppMaster.io
Assim, você pode encontrar as configurações da API em vários lugares da nossa plataforma.
Como criar um API Endpoint na plataforma sem código AppMaster.io
Faça login em sua conta para um projeto existente.
Vá para Designer de Modelo de Dados. No Data Model Designer, você verá modelos com dados que deseja processar usando a API de endpoints. Em cada projeto, no início, há sempre um modelo por padrão, o Usuário. Se você está em um novo projeto e ainda não tem seus modelos, crie-os.
Atribua links entre seus modelos e salve o projeto.
Vá para a seção Endpoints no menu esquerdo da tela.
Aqui você verá uma lista de todos os seus endpoints e os métodos da API REST disponíveis para eles conectados a cada modelo no campo do projeto. Você removerá métodos desnecessários e alterará suas configurações (ícone de engrenagem e ícone da Lixeira).
Se não houver endpoint adequado na lista, você pode criar um novo clicando no botão New Endpoint e selecionando o tipo apropriado. Uma janela modal com as configurações do Endpoint será aberta.
Como criar uma API externa na plataforma sem código AppMaster.io
Vá para a seção Business Logic no menu à esquerda.
Aqui você pode criar uma solicitação de API externa na guia Solicitação de API externa (esta opção está em versão beta).
Além disso, como mencionamos acima, toda a documentação é gerada automaticamente e salva no formato OpenAPI (Swagger) no back-end de sua aplicação.
Swagger é a documentação e a capacidade de testar todos os endpoints no local sem usar aplicativos de terceiros, como o Postman.
Conclusão
Como você pode ver, criar e alterar as configurações da API sem código é muito simples e leva um tempo mínimo. Se você ainda não tem uma conta no AppMaster.io, junte-se a nós e inscreva-se para uma versão de avaliação .
