Participe da Maratona Behind the Code! A competição de programação que mais te desafia! Inscreva-se aqui

Criando uma API em poucos minutos em Node.js com STRAPI

Criando uma API em poucos minutos em Node.js com STRAPI

1

– Softwares necessários

Neste tutorial, não pretendo cobrir como instalar os seguintes softwares que serão necessários:

2

– Primeiros passos

2.1 – Instalando o CLI

Para começar, vamos instalar o STRAPI globalmente

npm install strapi@alpha -g

2.2 – Iniciando o projeto

Assim que estiver finalizado, vamos criar um projeto novo com o nome “trivia”

strapi new trivia

instalando

Conforme a imagem acima, a sequencia de escolhas foi a seguinte:

  1. Choose your instalation type:

  2. Custom (manual settings)

  3. Choose your main database

  4. MongoDB

  5. Database name

  6. trivia

  7. Host:

  8. 127.0.0.1

  9. +srv connection

  10. false

  11. Port (it will be ignored if you enable +srv)

  12. 27017

  13. Username

  14. vazio

  15. Password

  16. vazio

  17. Authentication database (Maybe “admin” or blank)

  18. vazio

  19. Enable SSL connection

  20. false

2.3 – Rodando o servidor localmente

cd trivia;
strapi start;

Se tudo deu certo, abra seu navegador e entre em http://localhost:1337/admin

2.4 – Configurando o administrador

login
  1. Defina o “login” / apelido do seu usuário, que sempre será usado para autenticação.

  2. Insira uma senha.

  3. Confirme a senha.

  4. Adicione um e-mail para validar seu usuário.

  5. Clique em “ready to start” para finalizar a instalação.

3

– Conhecendo a STRAPI

3.1 – Painel de Administração

painel de administrador

Essa é a principal visualização do CMS STRAPI.
Nele existe um menu de navegação à esquerda, onde encontraremos tudo que vamos precisar neste tutorial.

4

– Adicionando Tipos de Conteúdo

  • No painel de administração, no menu à esquerda, clique em “Content Type Builder”.

  • Em “Content Type Builder” (imagem abaixo), clique em “Add Content Type”, no canto superior direito.

    tipos de conteúdo
  • Uma modal irá aparecer, requisitando um nome ao seu novo “Content Type”.

  • Feito isso, clique em “Save”.

    adicionar novo conteúdo
  • A tela vai mudar, a modal vai sumir e agora clique em “Add new Field”.

    conteúdo vazio
  • Uma extensa lista com tipos de campos vai aparecer. Para este tutorial, vou abordar inicialmente campos do tipo “String” e “Text”.

  • Clique em “String”.

    adicionar campos
  • Na nova janela, coloque como nome do campo “trivia”.

  • E depois na aba “Advanced Settings”.

    adicionar string
  • Na nova aba, marque:

  • “Required Field”.
  • “Unique Field”.
  • Minimum Length.
  • 5.
  • Clique em “+ Add new field”.

    adicionar string avançda
  • Voltamos a tela de tipos de campos, clique em “Text”.

    adiionar campos
  • Na nova janela, coloque como nome do campo “descricao”.

  • E depois na aba “Advanced Settings”.

    adicionar string
  • Na nova aba, marque:
    – “Display as a WYSIWYG”.

  • Clique em “Continue”.

    adicionar texto avançado
  • Agora que temos dois campos para o nosso tipo de conteúdo, clique em “Save”, no canto superior direito.

    conteúdo cheio
5

– Adicionando Conteúdo

Agora que temos um tipo de conteúdo “Trivia”, podemos clicar no menu esquerdo em “Trivias”, primeira opção em baixo de “Content Types”.

  • Após entrar no menu de Trivias, clique em “Add new Trivia”, no canto superior direito.

    adicionar conteúdo
  • Dê um nome e uma descrição à sua nova entrada e clique em “Save”, no canto superior direito.

    nova entrada
6

– Permissões da API

6.1 – Dando/Removendo permissões

Agora que temos um tipo de conteúdo “Trivia”, podemos clicar no menu esquerdo em “Roles & Permissions”, na seção de “Plugins”.

  • Na seção de “Roles & Permissions”, na lista de tipos de usuários, clique no ícone de lápis, à direita, na linha do tipo “Public”.

    permissões
  • Do meio da tela para baixo, na zona de “Permissions”, existe uma lista de check-boxes para o tipo de conteúdo “Trivia”, marque:
    – find
    – findone

  • Clique em “Save” no campo superior direito da tela.

    permissões públicas

6.2 – Testando permissões

Se você seguiu os passos das seções:

7

– Bônus

7.1 – Suporte a outras linguas

Zuntini, tá de sacanagem? Você me fez seguir o tutorial todo em inglês quando havia uma opção para traduzir o painel todo para português?

Sim, fiz!

Uma vez que o que vou mostrar a seguir só funciona para a interface e não para os plugins ou para todas as partes do sistema, preferi usar a interface em inglês para o tutorial ;p

  • No menu lateral esquerdo, opção “Configuration”, na aba “Language”, existem algumas das línguas que podem ser usadas para grande parte do sistema.
  • Mas, no canto superior direito, ao lado do nome do seu usuário (no meu caso, Felipe), existe uma bandeira, clique nela e selecione pt-br.

    idiomas
  • Deixando assim a bandeira verde e amarela selecionada e grande parte da interface em nossa língua maravilhosa.

    português

7.2 – Documentação

No menu lateral esquerdo, na opção “Marketplace”, é possível encontrar vários plugins legais para a STRAPI.

  • Um deles é o plugin de documentação, que gera uma documentação no visual SWAGGER, que pode ou não ser aberta (dá para colocar senha) – mas que não pretendo me aprofundar muito.

    documentação