Framework LoopBack 4.0 <a href="loopback.4.html" target="_blank" title="Pressione aqui para expandir este documento em nova aba."

1. INDEX

Introdução
Descrição.
Instalar
Exemplos.
Conteúdo01
Referências.
Histórico.

2. CONTEÚDO

Introdução
1. Objetivo:
  1. LoopBack 4.0 é um framework Node.js escrito na linguagem TypeScript, altamente extensível e de código aberto baseado no Express. Ele permite que você crie rapidamente APIs e micros serviços compostos de sistemas de back-end, como bancos de dados e serviços SOAP ou REST.
  2. [🔙]
2. Pre-requisitos:
  1. O programa nodejs é um programa tipo browser que executa JavaScript fora de um navegador web, permitindo acesso a funções do sistema operacional no lado do servidor.
  2. O programa npm significa Node Package Manager e é uma ferramenta que nos permite instalar e gerenciar pacotes de nodejs como dependências.
  3. O programa npx é um executor de pacote NPM que torna realmente fácil instalar qualquer tipo de executável de nodejs que normalmente teria sido instalado usando NPM.
  4. [🔙]
3. Benefícios:
  1. Define seus schemas e endpoints da API usando o padrão OpenAPI.
  2. Integra com bancos de dados, serviços web e outras plataformas usando conectores.
    1. Os conectores são uma espécie de api para acessar as seguintes tecnologias:
      1. Conectores de acesso a memória;
      2. Conectores de acesso a banco de dados;
        
        mysql/mariadb;
        
        Open api
      3. Conectores API rest ou soap.
      4. Vários outros conectores construídos pela comunidade.
  3. Use seus endpoints e schema como “source of truth” sem a necessidade de geração de código.
  4. [🔙]

Descrição

Visão geral.
1. Veja o conceito do loopback 4 para ter uma visão geral do framework.
  1. Application : A classe central para configurar todos os componentes, controladores, servidores e ligações do seu módulo. A classe Application estende Context e fornece os controles para iniciar e parar seus servidores associados.
  2. Server : Classe responsável pela implementação para transportes / protocolos de entrada, como REST (http, https), gRPC (http2) e graphQL (http, https). Ele geralmente escuta em um endpoint (protocol/host/port), trata das solicitações de entrada e retorna as respostas apropriadas.
  3. Controller : Classe que implementa operações definidas pela API REST do aplicativo. Ele implementa a lógica de negócios de um aplicativo e atua como uma ponte entre a API HTTP/REST e os modelos (models) de domínio/database. Um controlador opera apenas em entradas processadas e abstrações de serviços de back-end /databases.
  4. Interceptor : É uma função que intercepta invocações de métodos estáticos ou de instância em uma classe ou objeto.
  5. Route : É o mapeamento entre sua especificação de API e uma operação. Ele diz ao LoopBack para qual Operação invoke() quando recebe uma solicitação HTTP.
  6. Sequence : É um agrupamento sem estado de ações que controlam como um servidor responde às solicitações.
  7. DataSource : é um nome dado à configuração de conexão para um banco de dados de um servidor. O nome é normalmente utilizado quando cria-se uma consulta para o banco de dados. O DSN (Datasource Name) não tem que ser o mesmo que o nome do arquivo para o banco de dados. Por exemplo, um arquivo de banco de dados chamado "amigos.mdb" poderia ser definido com um DSN de "escola". O DSN "escola" seria então utilizado para referir-se ao banco de dados quando realizasse uma consulta.
  8. Model : São classes com a definição dos campos da fonte de dados. O @loopback/repository módulo fornece decoradores especiais para adicionar metadados às classes TypeScript/JavaScript para usá-los com o DataSource. Além disso, o@loopback/repository-json-schema módulo usa os metadados dos decoradores para construir um esquema JSON correspondente.
  9. Repository : é um tipo de serviço que representa uma coleção de dados em um DataSource.
  10. Relation : Um mapeamento entre dois modelos que descreve um link do mundo real entre eles e expõe APIs CRUD com base na configuração.
  11. Decorator : é o padrão usado para anotar ou modificar suas declarações de classe e seus membros com metadados.
2. Aqui estão as infraestruturas que fazem todos os artefatos trabalharem juntos:
  1. Context : Uma abstração de estados e dependências em seu aplicativo que o LoopBack usa para gerenciar tudo. É um registro global para tudo em seu aplicativo (configurações, estado, dependências, classes e assim por diante).
  2. Binding : Uma abstração de itens gerenciados por um contexto. Cada ligação possui uma chave exclusiva dentro do contexto e um provedor de valor para resolver a chave para um valor.
  3. Dependency injection : A técnica usada para separar a construção de dependências de uma classe ou função de seu comportamento para manter o código fracamente acoplado.
  4. Component : é um pacote que reúne uma ou mais extensões LoopBack.
3. Fluxograma dos componentes:
  1. key-concepts-overview-diagram
4. O loopback 4 possue o cliente lb4 que cria a parte braçal do código loopback 4, porém para saber a sequência de quais opções devo executar primeiro, é necessário conhecer o documento abaixo:
  1. Definindo a API usando abordagem de código primeiro.
5. Os loopback 4.0 possuem cinco componentes para criar aplicativos back-end:
  1. Controles (Controllers)
    1. Os controles definem as rotas da plicação para que as mesmas possam ser acessadas pelo browser via http.
  2. Fontes de dados e conectores de banco de dados (DataSources and Database connectors)
    1. As fontes de dados (DataSources) são usadas para conexão com banco de dados. As propriedades de configuração variam de acordo com os conectores. Por exemplo, uma fonte de dados para MySQL precisa definir o connector loopback-connector-mysql com as configurações a seguir:
      1. Código javascript
```
   {
      const config = {
         name: 'db',
         connector: 'mysql',
         url: '',
         host: 'localhost',
         port: 3306,
         user: 'loopback',
         password: 'pa55w0rd',
         database: 'demo',
      };

   }
```
    2. Os conectores são programas que conhecem vários tipos de banco de dados. Nota: Para cada banco de dados temos um conector.
  3. Modelos (Model e Entity)
    1. Os modelos são usados para mapear as tabelas dos bancos de dados.
  4. Repositórios (repositories) com os metadados
    1. Os repositórios são usados para criar relacionamentos entre os modelos.
    2. Relacionamentos possíveis:
      1. Um para N (hasMany) (hasMany Relation), veja diagrama abaixo:
        
        Exemplo:
        
        erDiagram Cliente ||--o{ Pedido : "1 para n" Cliente { number id string razaoSocial } Pedido { number clienteId number Qt number valorUnit }
        
        Relação pertence a (belongsTo Relation) essa relação funciona melhor com bancos de dados que suportam restrições de chave estrangeira (SQL).
        
        Uma relação belongsTo denota uma conexão muitos-para-um de um modelo a outro modelo por meio da integridade referencial.
        
        A integridade referencial é imposta por uma restrição de chave estrangeira no modelo de origem, que geralmente faz referência a uma chave primária no modelo de destino.
        
        Essa relação indica que cada instância do modelo declarante ou de origem pertence a exatamente uma instância do modelo de destino. Por exemplo, em um aplicativo com clientes e pedidos, um pedido sempre pertence exatamente a um cliente, conforme ilustrado no diagrama abaixo.
        
        Exemplo:
        
        erDiagram Cliente ||--|{ Pedido : "n para 1" Cliente { int id string razaoSocial } Pedido { int clienteId int Qt int valor }
      2. .
  5. .
6. [🔙]

Convenções de nomes de classes, arquivos e variáveis lb4

Nome da classe: PascalCase.
1. PascalCase é uma convenção de nomenclatura em que a primeira letra de cada palavra em uma palavra composta é maiúscula. Veja mais...
  1. Exemplo:
```
   export class CadastroDeClientes extends Entity {}
```

O nome do arquivo: kebab-case.

kebab-case - é uma convenção de nomenclatura de variável de programação onde um desenvolvedor substitui os espaços entre as palavras por um travessão e todas as letras devem ser minusculas ou maiúsculas. Veja mais...
1. Exemplo:
  1. cadastro-de-clientes.ts
  2. CADASTRO-DE-CLIENTES.TS

Nota: O programa lb4 convencionou o nome de arquivos da seguinte forma:

Entrada	Caso	Nome da Classe	Nome do arquivo
MyModel	A entrada permanece a mesma	MyModel	my-model.model.ts
my_model	Os sublinhados são removidos	MyModel	my-model.model.ts
My-Model	O nome da classe não pode conter alguns símbolos	Inválido	Inválido

Nome da variável: camelCase.
1. camelCase é uma convenção de nomenclatura na qual a primeira letra de cada palavra em uma palavra composta é maiúscula, exceto para a primeira palavra. Veja mais....
  1. Exemplo:
```
   var nomeDoCliente = string;
```
[🔙]

lb4 - Aplicativo de linha de comando:
1. Usage:
  1. lb4 app [<name>] [options]
2. Options:
  1. -h, --help # Imprimir as opções e o uso do gerador
  2. --skip-cache # Não lembrar respostas do prompt Default:false
  3. --skip-install # Não instalar dependências automaticamente Default: false
  4. --force-install # Erro de falha na instalação de dependências Default: false
  5. --ask-answered # Show prompts for already configured options Default: false
  6. --applicationName # Nome da classe do aplicativo
  7. --docker # Incluir Dockerfile e .dockerignore
  8. --repositories # Inclua importações de repositório e RepositoryMixin
  9. --services # Inclua importações de proxy de serviço e ServiceMixin
  10. --apiconnect # Incluir ApiConnectComponent
  11. --description # Descrição para o application
  12. --outdir # Diretório-raiz do projeto para o application
  13. --eslint # Ativar eslint
  14. --prettier # Ativar o Prettier
  15. --mocha # Ativar mocha
  16. --loopbackBuild # Use @loopback/build
  17. --vscode # Usar definições de VSCode pré-configuradas
  18. --private # Marque o projeto como privado (excluído da publicação npm)
  19. -c,--config # Nome ou valor do arquivo JSON para configurar opções
  20. -y,--yes # Ignore todos os prompts de confirmação com valor padrão ou fornecido
  21. --format # Formate o código gerado usando npm run lint:fix
  22. -pm, --packageManager # Mude o gerenciador de pacote padrão
3. Arguments:
  1. name # Nome do projeto para o application Type: String Required: false
4. Available commands:
  1. lb4 app # Cria um novo aplicativo LoopBack4 usando a API REST.
  2. lb4 extension # Cria uma nova extensão LoopBack4.
  3. lb4 controller # Adicionar um novo controlador a um aplicativo LoopBack 4.
  4. lb4 datasource # Adicionar uma nova fonte de dados a um aplicativo LoopBack 4.
  5. lb4 import-lb3-models # Importe um ou mais modelos LoopBack 3 para um aplicativo LoopBack 4.
  6. lb4 model # Adicionar um novo modelo a um aplicativo LoopBack 4.
  7. lb4 repository # Adicionar novos repositórios para o (s) modelo (s) selecionado (s) a um aplicativo LoopBack 4.
  8. lb4 service # Adicionar um novo serviço remoto ou local a um aplicativo LoopBack 4.
  9. lb4 example # LoopBack 4 vem com vários projetos de exemplo.
  10. lb4 openapi # Gerar controladores e modelos a partir de especificações OpenAPI.
  11. lb4 observer # Gerar observadores de ciclo de vida para iniciar / parar o aplicativo.
  12. lb4 interceptor # Gerar interceptores.
  13. lb4 discover # Descubra modelos de bancos de dados relacionais.
  14. lb4 relation # Adicione uma relação entre dois modelos em um aplicativo LoopBack 4.
  15. lb4 update # O lb4 update comando é executado dentro de um projeto LoopBack 4 e verifica as dependências em relação à versão atual do @loopback/cli. Por padrão, ele verifica a correspondência exata. Use a --semver opção para verificar a compatibilidade usando semver semântica.
  16. lb4 rest-crud # Gerar configurações restantes para endpoints do modelo.
  17. lb4 copyright # O lb4 copyright comando é executado dentro de um projeto Node.js package.json para adicionar ou atualizar o cabeçalho de copyright / licença para arquivos JavaScript e TypeScript com base em um package.json histórico git.
    O comando também oferece suporte a lerna monorepos. Ele atravessa todos os pacotes dentro do monorepo e aplica cabeçalhos de copyright/licença.
  18. install-completion
  19. lb4 uninstall-completion
[🔙]

Instalar loopback
1. O LoopBack 4 CLI é uma interface de linha de comando que estrutura um projeto ou uma extensão gerando o código básico. A CLI fornece a maneira mais rápida de começar com um projeto LoopBack 4 que segue as melhores práticas.
2. Instalar loopback CLI toolkit.
  1. Código shellscript:
```
   
   sudo npm i -g @loopback/cli
```
3. [🔙]
Exemplos.
1. Passo a passo para criar projeto usando o programa lb4:
  1. Criar um novo projeto de nome getting-started:
    1. Criar projeto getting-started:
      1. Código shellscript
        
        lb4 app
        
        Responda a pegunta do comando lb4 app:
        
        ? Nome do projeto: getting-started
        
        ? Descrição do projeto: Getting started tutorial
        
        ? Diretório-raiz do projeto: getting-started
        
        ? Nome da classe do aplicativo: StarterApplication
        
        ? Select project build settings: (Press <space> to select, <a> to toggle all, <i> to invert selection):
        
        ◉ Ativar services: Incluir importações de proxy de serviço e o ServiceMixin
        
        ◉ Ativar eslint: Incluir um linter com regras de lint pré-configuradas
        
        ◉ Ativar prettier: Instalar Prettier para formatar código em conformidade com as regras
        
        ◯ Ativar mocha: Instale o mocha para executar testes
        
        ◉ Ativar loopbackBuild: use os auxiliares @loopback/build (por exemplo, lb-eslint)
        
        ◉ Ativar vscode: Inclua arquivos de configuração de VSCode
        
        ◉ Ativar repositories: Incluir importações de repositório e o RepositoryMixin
        
        ◯ Ativar docker: Incluir Dockerfile e .dockerignore
        
        (Mova para cima e para baixo para revelar mais opções)
    2. Nota: O projeto getting-started criado pelo comando lb4 app possui arquivos e diretórios no diretório raiz do aplicativo . Dentro desse diretório, a estrutura do aplicativo LB4 padrão tem estes subdiretórios:
      1. src - Código-fonte TypeScript e arquivos de configuração.
      2. public - Ativos do lado do cliente (arquivos JavaScript, HTML e CSS) para a página inicial.
      3. dist/ -
      4. Veja mais...
    3. [🔙]
  2. Iniciando o projeto getting-started:
    1. Código shellscript
```
   
   cd getting-started
   npm start
```
    1. Digite no browser o comando: http://localhost:3000/ping
      1. A resposta será o objeto jsom:
        
        Código jsom
        
        /** Response headers access-control-allow-credentials: true access-control-allow-origin: * connection: keep-alive content-length: 779 content-type: application/json date: Wed,10 Mar 2021 14:04:19 GMT keep-alive: timeout=5 x-powered-by: Express */ /**Response body */ { "greeting": "Hello from LoopBack - 01", "date": "2021-03-10T14:04:19.400Z", "url": "/ping", "headers": { "host": "localhost:3000", "connection": "keep-alive", "sec-ch-ua": "\"Google Chrome\";v=\"89\", \"Chromium\";v=\"89\", \";Not A Brand\";v=\"99\"", "accept": "application/json", "sec-ch-ua-mobile": "?0", "user-agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36", "sec-fetch-site": "same-origin", "sec-fetch-mode": "cors", "sec-fetch-dest": "empty", "referer": "http://localhost:3000/explorer/", "accept-encoding": "gzip, deflate, br", "accept-language": "pt-BR,pt;q=0.9,en-US;q=0.8,en;q=0.7,en-CA;q=0.6,de-DE;q=0.5,de;q=0.4,fr;q=0.3,es;q=0.2,zh-CN;q=0.1,zh;q=0.1,fr-CA;q=0.1,en-GB;q=0.1,ja;q=0.1,af;q=0.1", "cookie": "io=kpnuqyjQiI7YMGdNAAAG" } }
    2. Finaliza a execução do programa pressiona Ctrl C no terminal onde o programa getting-started está executando.
    3. [🔙]
  3. Adicionando o controlador hello ao projeto getting-started:
    1. Agora que temos um projeto básico criado, é hora de adicionar controladores.
      1. Adicionar o controlador “Hello” simples da seguinte maneira:
        
        Código shellscript
        
        lb4 controller
        
        Responda as peguntas do comando lb4 controller:
        
        ? Nome da classe do controlador: hello
        
        ? Que tipo de controlador você gostaria de gerar? (Use arrow keys ↕)
        
        Controlador vazio
        
        Controlador de REST com funções de CRUD
        
        Resposta a essa pergunta:
        
        Controlador vazio
        
        Mensagens após o término das respostas:
        
        Criou: src/controllers/hello.controller.ts
        
        Atualizou: src/controllers/index.ts
        
        O controlador "hello" foi criado em: src/controllers/.
        
        Cole o seguinte código typescript no arquivo /src/controllers/hello.controller.ts:
        
        Código typescript
        
        import {get} from '@loopback/rest'; export class HelloController { @get('/hello') hello(): string { return 'Hello world!'; } }
        
        Para testar se o controller hello está funcionando execute o comando abaixo:
        
        Código shellscript
        
        npm start
        
        Digite no browser o comando: http://localhost:3000/hello
        
        Resposta: Hello world!
        
        Finaliza a execução do programa pressiona Ctrl C no terminal onde o programa getting-started está executando.
    2. [🔙]
  4. Adicionando a entidade <entity> cliente ao projeto getting-started.
    1. Entidade <entity> é um modelo que possue a propriedade id único conforme o exemplo abaixo:
    2. Código ShellScript
```
   lb4 model
```
    3. Responda as perguntas do comando lb4 model:
      1. ? Nome da classe Model: cliente
      2. ? Selecione a classe base do modelo Entity (Entity é uma classe model com a propriedade id)
      3. ? Permitir propriedades adicionais (formato livre)? Yes
        
        Resposta do comando lb4 model:
        
        Model Cliente será criado em: src/models/cliente.model.ts
        
        Vamos incluir uma propriedade em Cliente
        
        Insira um nome de propriedade vazio quando estiver pronto:
        
        Pergunta do comando lb4 model:
        
        ? Insira o nome da propriedade: nomeDoCliente
        
        ? Tipo de propriedade: string
        
        ? É necessário? Yes
        
        Vamos incluir outra propriedade no modelo Cliente:
        
        ? Insira o nome da propriedade (enter para finalizar): <enter>
        
        Resposta do comando lb4 model
        
        Criou arquivo: src/models/cliente.model.ts
        
        Atualizou arquivo: src/models/index.ts
        
        O Model Cliente foi criado em src/models
    4. Arquivo criado src/models/cliente.model.ts com a entidade Cliente.
      1. Código typescript
        
        import {Entity, model, property} from '@loopback/repository'; @model({settings: {strict: false}}) export class Cliente extends Entity { @property({ type: 'number', id: true, generated: true, }) id?: number; @property({ type: 'string', required: true, }) nomeDoCliente: string; // Define well-known properties here // Indexer property to allow additional data // eslint-disable-next-line @typescript-eslint/no-explicit-any [prop: string]: any; constructor(data?: Partial<Cliente>) { super(data); } } export interface ClienteRelations { // describe navigational properties here } export type ClienteWithRelations = Cliente & ClienteRelations;
      2. .
  5. Adicionar o controlador crud01 da seguinte maneira:
    1. Código shellscript
```
   lb4 controller
```
    2. Responda as peguntas do comando lb4 controller:
      1. ? Nome da classe do controlador: crud01
      2. ? Que tipo de controlador você gostaria de gerar? (Use arrow keys ↕)
        
        Controlador vazio
        
        Controlador de REST com funções de CRUD
        
        Resposta a essa pergunta:
        
        Controlador de REST com funções de CRUD
      3. Mensagens após o término das respostas:
        
        Criou: src/controllers/hello.controller.ts
        
        Atualizou: src/controllers/index.ts
        
        O controlador hello foi criado em: src/controllers/.
    3. ,
  6. Referência dos passos criados acima....
  7. .
  8. .
2. Exemplo criado por cli lb4:
  1. getting-started (Começando)
  2. @loopback/example-hello-world
  3. @loopback/example-todo.
  4. Creating CRUD REST APIs from a model
  5. MySQL Connector Tutorial
  6. .
3. .
4. [🔙]
Conteúdo01
1. item 01.
2. item 02.
3. [🔙]
REFERÊNCIAS
1. #
2. #
3. #
4. #
5. #
6. [🔙]
HISTÓRICO
1. dd/mm/2021
  - [🔙]
2. dd/mm/2021
  - Criar este documento baseado no loopback.4.md ;
  - Escrever tópico Objetivos;
  - Escrever tópico Pre-requisitos
  - Escrever tópico Benefícios
  - Escrever tópico Descrição
  - Escrever tópico Conteúdo 02
  - Escrever tópico Referências
  - Atualizar o histórico deste documento.
  - Ler no dia seguinte este documento para checar os erros de português.
  - [🔙]

🔝🔝

   classDiagram
      Customer <|-- Order
      Customer : +int id
      Customer : +String name
   
      class Order{
         +int id
         +int customerId
         +string name
         +boolean isisDelivered
      }

   classDiagram
        
        Animal <|-- Duck
        Animal <|-- Fish
        Animal <|-- Zebra
        Animal : +int age
        Animal : +String gender
        Animal: +isMammal()
        Animal: +mate()
        class Duck{
           +String beakColor
           +swim()
           +quack()
        }
        class Fish{
           -int sizeInFeet
           -canEat()
        }
        class Zebra{
           +bool is_wild
           +run()
        }