Tutorial: Criar rapidamente uma API com o loopback da IBM e mongoDB

O LoopBack é uma framework para criação de API Node.js que permite criar funcionalidades de back-end. Esta framework funciona como um assistente de criação da API. O programador facilmente pode definir uma modelo de dados, criar controladores, ligar a sua API com bases de dados, etc.

Saiba como criar rapidamente uma API com o loopback da IBM e mongoDB.

Para este tutorial vamos usar o loopback 4, que é a nova versão da ferramenta da IBM. Esta nova versão é ainda mais simples de usar e flexível. Tem suporte para OpenAPI e também GraphQL.

Criar API com o loopback da IBM e mongoDB

Para usar esta plataforma vamos realizar os seguintes passos:

• Passo 1) Instalar o NodeJS
• Passo 2) Instalar o LoopBack 4 e o conetor à Base de dados
• Passo 3) Organização da API
• Passo 4) Criar o Modelo
• Passo 5) Definir o DataSource
• Passo 6) Adicionar Repositório
• Passo 7) Adicionar Controller

Instalar o NodeJs e LoopBack

Passo 1 — Instalar o NodeJS (macOS, Linux, Windows) e o mongoDB.

Depois de instalado o NodeJS, podem instalar o LoopBack 4 via CLI usando o gestor de pacotes npm.

Passo 2 — Instalar o LoopBack 4 via CLI

npm i -g @loopback/cli
npm install --save loopback-connector-mongodb

Passo 3) Organização da AP

Para começar a criar a app devemos usar o comando lb4 <nome_app>. Depois basta indicar uma descrição do projeto, nome da classe da app e que tipo de recursos pretendem ativar no projeto.

No final da criação da API devem ver a seguinte informação. Podem testar de imediato a API ou então continuar o tutorial.

A estrutura da API (que se encontra em/src) é a seguinte…

Passo 4) Criar o Modelo

O Modelo está relacionado com a base de dados. Para este exemplo vamos definir a seguinte estrutura de tabela:

• id: id único
• titulo: titulo da tarefa
• desc: descrição da tarefa
• isDone: informação se a tarefa está finalizada

Passo 5) Definir o DataSource

O LoopBack usa datasources para se ligar a fontes de dados, como base de dados, ficheiros, APIs, etc. Neste exemplo vamos ligar a nossa API à base de dados em mongoDB. Para criar um DataSource vamos usar o comando lb4 datasource

Passo 6) Adicionar Repositório

Um repositório representa uma interface que fornece operações de acesso a dados e consulta de dados(por exemplo, CRUD). Para criar um repositório basta usar o comando lb4 repository

Passo 7) Adicionar Controller

No LoopBack 4, os controladores (controller) lidam com o ciclo de vida do pedido-resposta para a API. Cada função tem um controlador.

E está feito. Para executar a sua API basta que usem o comando npm start. Depois basta aceder ao endereço http://127.0.0.1:3000/explorer/. O resultado deverá ser o seguinte.

Como podem ver, o loopback criou todas as funções CRUD que é a sigla para Create, Read, Update e Delete. Estas são as quatro operações básicas utilizadas em bases de dados relacionais (RDBMS). A abreviação CRUD mapeada para o padrão ISO/SQL:

• Create — INSERT
• Read — SELECT
• Update — UPDATE
• Delete — DELETE

Num próximo tutorial iremos mostrar como podem interagir com a API. Estejam atentos.

Leia também...