STRAPI NODEJS CMF | Nunca foi tão fácil criar uma API | Documentação | SW9

Olá Pessoal. Sejam Bem Vindos ao canal e blog SW9 (http://blog.sw9.com.br) ?

Tem muita coisa legal que eu gostaria de compartilhar sobre o STRAPI, portanto, fiquem atentos que os próximos episódios serão dedicados a ele. ?

Todo o conteúdo preparado durante esta imersão, vai fornecer todas as condições para utilizar o STRAPI nos seus projetos, trazendo segurança, facilidade de manutenção, escalabilidade e performance. Então você é o meu convidado a partir de agora para acompanhar esta nova forma de construir APIs.?

#O que vimos no episódio anterior?

No quinto episódio da série, você teve contato com o recurso Rate Limit, aprendendo a ativá-lo para um determinado endpoint, e acompanhar o comportamento dele a cada requisição. Você perdeu este conteúdo ?? Não se preocupe, segue o link para acessá-lo http://blog.sw9.com.br/2019/08/20/strapi-nodejs-cmf-nunca-foi-tao-facil-criar-uma-api-rate-limit-sw9

#O que você vai aprender hoje?

Hoje vamos ativar a extensão de documentação, possibilitando gerar a documentação de nossas APIs de forma automática :D. Demais né?

#Mais sobre a extensão de documentação?

Já passamos pela instalação, criação de content types, definição de permissões de acesso e realizamos testes fazendo requisições aos nossos endpoints. Mas aí você você me pergunta: e a documentação? E se eu quiser criar e manter uma documentação dos meus endpoints ? A única resposta que posso te dar é: criar documentação de seus endpoints usando a infraestrutura do STRAPI é muito simples e rápido.

O STRAPI permite instalar um plugin para documentação que usa com base o Swagger UI. Depois de instalado o plugin, o mesmo vai varrer todas as rotas disponíveis no estrutura de diretórios do projeto e criar a documentação apropriada de cada endpoint localizado. Encerrado este processo de varredura, você poderá consultar toda a documentação a partir de uma página web que fica acessível a partir da própria área admin do STRAPI.

#Instalando a extensão

Existem duas alternativas para instalar o plugin de documentação. O primeiro método é a partir da própria área admin do STRAPI, neste caso você deve acessar o menu [Marktplace] e localizar a plugin de documentação.  Localizado o plugin, você deve apenas clicar no botão [Baixar] e o processo de donwload e instalação vai iniciar automaticamente. Ao final da instalação, uma nova opção de menu vai surgir na área admin.

O segundo método de instalação é a partir do terminal (prompt de comando). Você deve acessar o diretório do projeto e na sequencia digitar o comando [strapi install documentation].  O processo pode levar alguns minutos e após a finalização, você pode digitar o comando [strapi develop] para iniciar o módulo Admin do STRAPI, localizar o novo link de documentação e finalmente consultar a documentação das APIs criadas.

Apesar do primeiro método ser mais intuitivo, eu particularmente recomendo o uso do segundo método.

#Arquitetura da documentação

O plugin segue a especificação Open API e gera uma estrutura de diretórios padronizada que permite customizarmos a documentação conforme a nossa necessidade. Infelizmente esta parte de customização não será o escopo desta série.

#Consultando a Documentação

Instalado o plugin, chegou o momento tão esperado: consultar a documentação das APIs que criamos nos episódios anteriores. Para isso, devemos acessar a nova opção de menu que ficou disponível do lado esquerdo da área admin do STRAPI, selecionar a API desejada e pronto, todos os endpoints aparecem documentados. Inclusive você poderá testar todos os endpoints a partir desta mesma interface. ???

#Hora de assistir ao vídeo

Chegou o momento de arregaçar as mangas e colocar a mão na massa. ?? ??‍♂️ ?‍♀️

[Conclusão]

No episódio de hoje [STRAPI NODEJS CMF | Nunca foi tão fácil criar uma API | Documentação | SW9], você aprendeu a ativar a extensão de documentação de API e consultar a documentação que foi gerada automaticamente.

Bom, por hoje é só. Aproveitem o vídeo e bons estudos. Fiquem antenados, que em breve teremos mais novidades.

Espero que gostem deste vídeo. Aproveito para pedir a participação de vocês no canal e blog, curtindo, compartilhando, dando sua opinião e se inscrevendo no canal e blog para receber as novidades em primeira mão.

Fiquem com Deus e até o próximo vídeo.

[Links úteis]

Curso Relacionado: [Aprenda HTML 5 e CSS 3 e Comece a Criar Seus Próprios Sites] – https://goo.gl/QsLPph

Link do vídeo: https://youtu.be/aHsaWEucKaI

Playlist Ferramentas de Teste de API: https://www.youtube.com/watch?v=9GAl1nlNcbo&list=PLtluGZbI5ESiFrDDnKmwJNdrKZKI-hECj

PlayList Mega Série HTML5: https://www.youtube.com/watch?v=D-XN-miEwP0&list=PLtluGZbI5ESj8XWTJcJmrVW6Q_tCi7uR8

Área de Downloads: http://blog.sw9.com.br/acesso-area-de-downloads/

Meu Blog: http://blog.sw9.com.br

Meu GitHub: https://sw9brl.github.io/MyGitHubPage

Canal youtube: https://youtube.com/+sw9brl

✔ Clique em gostei ✔ Compartilhe ✔ Inscreva-se