Criar seu primeiro aplicativo usando o Node.js
Inicie o desenvolvimento de aplicativos do Microsoft Teams criando seu primeiro aplicativo com uma guia, um bot e uma funcionalidade de extensão de mensagem.
Esse aplicativo terá todos os recursos e cada um terá sua própria interface do usuário e experiência do usuário:
Neste tutorial, você aprenderá:
- Como configurar um novo projeto usando ferramentas de linha de comando.
- Como criar três aplicativos com uma funcionalidade diferente cada: guia, bot e extensão de mensagem.
- Como implantar seu aplicativo no Portal do Desenvolvedor.
Pré-requisitos
Aqui está uma lista de ferramentas que você precisará instalar para criar e implantar um aplicativo do Teams.
| Instalar | Para usar... | |
|---|---|---|
| Required | ||
| Node.js e NPM | Ambiente de runtime do JavaScript de back-end. Use a versão mais recente do v16 LTS. | |
| ngrok | Os recursos do aplicativo Teams (bots de conversa, extensões de mensagem e webhooks de entrada) exigem conexões de entrada. Um túnel conecta seu sistema de desenvolvimento ao Teams. Ele não é necessário para aplicativos que incluem apenas guias. Esse pacote é instalado no diretório do projeto (usando npm devDependencies). |
|
| Microsoft Edge (recomendado) ou Google Chrome | Um navegador com ferramentas de desenvolvedor. | |
| Visual Studio Code | Ambientes de compilação JavaScript, TypeScript ou Estrutura do SharePoint (SPFx). Use a versão 1.55 ou posterior. | |
| Git | Git para usar o repositório Node.js aplicativo de exemplo do GitHub. | |
| Gole | Kit de ferramentas JavaScript de software livre. Instale a versão 4.0.0 ou posterior. | |
| Microsoft Teams | O Microsoft Teams para colaborar com todos com quem você trabalha por meio de aplicativos para chats, reuniões, chamadas - tudo em um só lugar. | |
| Opcional | ||
| Ferramentas do Azure para Visual Studio Code CLI do Microsoft Azure | Ferramentas do Azure para acessar dados armazenados ou implantar um back-end baseado em nuvem para seu aplicativo Teams no Azure. | |
| React Developer Tools para Chrome OU React Developer Tools para Microsoft Edge | Ferramentas de navegador para desenvolvimento de guias com JavaScript. | |
| Microsoft Graph Explorer | Microsoft Graph Explorer, uma ferramenta baseada em navegador que permite executar uma consulta de dados do Microsoft Graph. | |
| Portal do Desenvolvedor do Teams | Portal baseado na Web para configurar, gerenciar e distribuir seu aplicativo do Teams, inclusive para sua organização ou para a loja do Teams. | |
| Visual Studio Code extensões | ||
| Ferramentas do Azure Functions Core versão 3. | Componentes de back-end localmente durante uma execução de depuração local, incluindo os auxiliares de autenticação necessários ao executar seus serviços no Azure. Ele é instalado no diretório do projeto (usando o npm devDependencies). |
|
| SDK DO .NET | Associações personalizadas para depuração local e implantações Azure Functions aplicativo. Se você não tiver instalado o SDK do .NET 3.1 (ou posterior) globalmente, a versão portátil poderá ser instalada. |
Verificar números de versão para ferramentas instaladas
Use os comandos a seguir para verificar se as versões instaladas para as ferramentas são necessárias.
Observação
Use a janela do terminal com a qual você está mais familiarizado em sua plataforma. Esses exemplos usam o Git Bash (que está incluído na instalação do Git), mas esses scripts serão executados na maioria das plataformas.
Para verificar os números de versão das ferramentas instaladas:
Abra uma janela de terminal.
Execute o seguinte comando para verificar a
gitversão instalada no computador:$ git --versionExemplo de saída:
git version 2.19.0.windows.1Execute o seguinte comando para verificar a
node.jsversão:$ node -vExemplo de saída:
v8.9.3Verifique o número de versão de
npm:$ npm -vExemplo de saída:
5.5.1Verifique o número de versão de
gulp:$ gulp -vExemplo de saída:
CLI version 2.3.0Local version 4.0.2Execute o seguinte comando para verificar o número de versão Visual Studio Code:
code --versionExemplo de saída:
1.28.2929bacba01ef658b873545e26034d1a8067445e9
Você pode usar uma versão diferente desses aplicativos sem nenhum problema.
Configurar seu locatário de desenvolvimento do Teams
Um locatário é como um espaço ou um contêiner para sua organização no Teams, onde você conversa, compartilha arquivos e executa reuniões. Esse espaço também é onde você faz sideload e testa seu aplicativo.
Vamos verificar se você está pronto para desenvolver com o locatário.
Habilitar a opção de sideload
Depois de criar o aplicativo, você deve carregar seu aplicativo no Teams sem distribuí-lo. Esse processo é conhecido como sideload. Entre em sua conta do Microsoft 365 para exibir essa opção.
Observação
O sideload é necessário para visualizar e testar aplicativos no ambiente local do Teams. Se ele não estiver habilitado, você não poderá visualizar e testar seu aplicativo no Teams localmente.
Você já tem um locatário e tem acesso de administrador? Vamos verificar se você realmente faz!
Verifique se você pode fazer sideload de aplicativos no Teams:
No cliente do Teams, selecione o ícone da Loja.
Selecione Gerenciar seus aplicativos.
Procure a opção para carregar um aplicativo personalizado. Se você vir a opção, o sideload de aplicativos estará habilitado.
Observação
Se o Teams não mostrar a opção de carregar um aplicativo personalizado, fale com o administrador do Teams.
Criar um locatário de desenvolvedor gratuito do Teams
Se você não tiver uma conta de desenvolvedor do Teams, poderá obtê-la gratuitamente. Participe do programa de desenvolvedor do Microsoft 365!
Selecione Ingressar Agora e siga as instruções na tela.
Na tela de boas-vindas, selecione Configurar assinatura do E5.
Configurar a conta de administrador. Depois de concluir, a tela a seguir será exibida.
Entre no Teams usando a conta de administrador que você acabou de configurar. Verifique se você tem a opção Carregar um aplicativo personalizado no Teams.
Obter uma conta gratuita do Azure
Se você quiser hospedar seu aplicativo ou acessar recursos no Azure, deverá ter uma assinatura do Azure. Crie uma conta gratuita antes de começar.
Agora você tem todas as ferramentas e configura suas contas. Em seguida, vamos configurar seu ambiente de desenvolvimento e começar a criar!
Você pode continuar a usar essa janela de terminal para executar os comandos a seguir neste tutorial.
Baixar o exemplo
Para este tutorial, use o Hello, World! exemplo para começar. Você pode baixá-lo e cloná-lo do GitHub.
Para usar o Git Bash para clonar o repositório de exemplo:
Abra uma janela de terminal.
Execute o seguinte comando para clonar o repositório de exemplo em seu computador:
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
Dica
Você pode bifurcar esse repositório se quiser modificar e verificar suas alterações no repositório GitHub para referência futura.
Criar seu primeiro Node.js aplicativo
Depois de clonar o repositório para Node.js aplicativo de exemplo, você pode compilar e testar o aplicativo em seu ambiente local.
Nesta página, você aprenderá a:
Criar e executar o exemplo
Depois que o repositório for clonado, você poderá criar o aplicativo de exemplo.
Abra uma janela de terminal.
Execute o comando alterar diretório no terminal para alterar para o diretório do aplicativo de exemplo:
cd Microsoft-Teams-Samples/samples/app-hello-world/nodejs/Instale todas as dependências usando o seguinte comando:
npm installVocê deve ver várias dependências sendo instaladas.
Execute o aplicativo usando o seguinte comando após a conclusão da instalação:
npm startQuando o Olá, Mundo é iniciado, ele é exibido
App started listening on port 3333na janela do terminal.Observação
Se você vir um número de porta diferente exibido na mensagem acima, é porque você tem uma variável de ambiente PORT definida. Você pode continuar a usar essa porta ou alterar sua variável de ambiente para 3333.
Abra uma janela do navegador e use as seguintes URLs para verificar se todas as URLs Olá, Mundo aplicativo estão carregando:
http://localhost:3333
http://localhost:3333/hello
http://localhost:3333/first
http://localhost:3333/second
Testar seu aplicativo de exemplo no ambiente local
Lembre-se de que os aplicativos no Microsoft Teams são aplicativos Web expondo um ou mais recursos. Disponibilizar seu aplicativo na Internet para que a plataforma teams possa carregá-lo. Para tornar seu aplicativo acessível pela Internet, você precisa hospedar seu aplicativo.
Para testes locais, você pode executar o aplicativo em seu computador local e criar um túnel para ele com um ponto de extremidade da Web. O ngrok é uma ferramenta gratuita que permite que você faça exatamente isso. Com o ngrok, você pode obter um endereço Web como https://d0ac14a5.ngrok.io (essa URL é apenas um exemplo). Você pode baixar e instalar o ngrok para seu ambiente. Certifique-se de adicioná-lo a um local no PATH.
Criar túnel ngrok
Depois de instalar o ngrok, você pode criar um túnel para implantar seu aplicativo localmente.
Abra uma nova janela de terminal.
Execute o comando a seguir para criar um túnel. O aplicativo de exemplo usa a porta 3333:
ngrok http 3333 -host-header=localhost:3333O túnel ngrok é criado. Aqui está um exemplo de túnel ngrok.
O Ngrok escuta solicitações da Internet e as roteará para seu aplicativo em execução na porta 3333.
Para verificar a implantação local do aplicativo:
Abra o navegador.
Carregue seu aplicativo usando a seguinte URL:
https://<forwarding address in ngrok console session>/Aqui está um exemplo da URL:
Você pode tentar adicionar
hello,firstou àsecondURL do túnel ngrok para exibir páginas de guias diferentes do aplicativo.O Ngrok escuta solicitações da Internet e as roteia para seu aplicativo em execução na porta 3333.
Anote o endereço de encaminhamento no console do ngrok. Você precisa dessa URL para implantar seu aplicativo no Teams.
Observação
Se você usou uma porta diferente durante a compilação e a execução, use o mesmo número da porta para configurar o túnel ngrok .
Dica
É uma boa ideia executar o ngrok em uma janela de terminal diferente para mantê-lo em execução sem interferir no aplicativo de nó, que talvez você posteriormente tenha que parar, recriar e executar novamente. A sessão ngrok retornará informações úteis de depuração nesta janela. A versão paga do ngrok permite nomes persistentes.
Importante
Se você usar a versão gratuita do ngrok, seu aplicativo estará disponível somente durante a sessão atual em seu computador de desenvolvimento. Ele não estará disponível se a máquina estiver desligada ou estiver dormindo. Quando você reinicia o serviço, ele retorna um novo endereço. Em seguida, você deve atualizar cada local que usa o endereço desatualizado. Lembre-se desta etapa ao compartilhar o aplicativo para teste.
Compilar Node.js pacote do aplicativo
Você pode usar gulp CLI para criar o pacote do aplicativo para Node.js.
Abra uma janela de terminal.
Verifique se você está no diretório em que o
node.jsarquivo é clonado. Esta é a pasta onde égulpfile.jscolocada.Execute o comando a seguir para compilar o pacote Node.js aplicativo.
$ gulpAqui está um exemplo da saída do comando:
[13:39:27] Using gulpfile ~\documents\github\msteams-samples-hello-world-nodejs\gulpfile.js[13:39:27] Starting 'clean'...[13:39:27] Starting generate-manifest'...[13:39:27] Finished 'generate-manifest' after 11 ms[13:39:27] Finished 'clean after 21 ms[13:39:27] Starting 'default'... Build completed. Output in manifest folder[13:39:27] Finished 'default' after 62 μsO pacote do helloworldapp.zip é criado. Você pode encontrar o arquivo de pacote no caminho a seguir.
<path to the cloned repo>/Microsoft-Teams-Samples/samples/app-hello-world/nodejs/manifestObservação
Procure o arquivo do pacote do aplicativo, helloworldapp.zip, se o local não estiver claro na ferramenta que você está usando.
Configurar seu primeiro aplicativo Node.js usando o Portal do Desenvolvedor
Você pode usar o Portal do Desenvolvedor para carregar o pacote do aplicativo no Teams e configurar os recursos do aplicativo. O Portal do Desenvolvedor é um aplicativo do Teams que simplifica a criação e o registro de um aplicativo. Instale na loja do Teams!
Depois de criar e testar seu aplicativo teams, você pode configurá-lo e visualizá-lo usando o Portal do Desenvolvedor.
A atualização do pacote do aplicativo inclui:
- Importando o pacote do aplicativo para o Portal do Desenvolvedor
- Configurando funcionalidades do aplicativo
Importar o pacote do aplicativo para o Portal do Desenvolvedor
Para importar o pacote do aplicativo:
Abra o Microsoft Teams.
Selecione o ícone
da Loja na barra à esquerda.Pesquise o Portal do Desenvolvedor na barra de pesquisa e selecione Portal do Desenvolvedor*.
Selecione Abrir.
O Portal do Desenvolvedor é aberto.
Selecione a guia Aplicativos .
Selecione Importar aplicativo.
Abra o pacote do aplicativo
helloworldapp.zipno seguinte caminho na estrutura de diretório do repositório de exemplo C#:<path to cloned node.js sample repo>\Source\Repos\Microsoft-Teams-Samples\samples\app-hello-world\nodejs\manifestO Olá, Mundo aplicativo é importado no Portal do Desenvolvedor.
Depois de importar seu aplicativo para o Portal do Desenvolvedor, você pode exibir seus detalhes no Portal do Desenvolvedor.
Faça um tour pelo seu aplicativo no Portal do Desenvolvedor
Depois de importar seu aplicativo para o Portal do Desenvolvedor, você pode exibir seus detalhes, incluindo o arquivo de manifesto.
Exibir informações do aplicativo
Selecione Informações Básicas no painel esquerdo do Portal do Desenvolvedor.
Observe as seguintes informações das informações básicas:
- ID do aplicativo
- Informações do desenvolvedor
- URLs do aplicativo
Selecione Identidade Visual no painel esquerdo para exibir as informações de identidade visual.
Esses detalhes serão importantes se você estiver escrevendo um novo aplicativo para distribuição.
Exibir recursos do aplicativo
Selecione Recursos do aplicativo no painel esquerdo do Portal do Desenvolvedor.
Os recursos do aplicativo aparecem no painel direito. Você pode exibir cartões para aplicativo pessoal, Bot e Extensão de Mensagem.
Exibir o manifesto do aplicativo
Use o arquivo de manifesto para configurar recursos, recursos necessários e outros atributos importantes para seu aplicativo.
Selecione Publicar no painel esquerdo para abrir a lista suspensa e, em seguida, selecione Pacote do aplicativo.
O manifesto do aplicativo aparece no painel direito.
O arquivo de manifesto aparece no painel direito.
Configurar os recursos do aplicativo
Depois de importar seu aplicativo para o Portal do Desenvolvedor, a próxima etapa é configurar os recursos do aplicativo. O Portal do Desenvolvedor contém todas as informações do aplicativo em seções diferentes. Isso facilita a configuração dos recursos do aplicativo.
Usando o Portal do Desenvolvedor, você pode:
Configurar o aplicativo de guia pessoal
Para configurar o aplicativo de guia pessoal:
Selecione o
ícone no cartão de aplicativo Pessoal no painel Recursos do aplicativo e selecione Editar.Os detalhes da guia Olá são exibidos.
Selecione o
ícone da guia Olá e selecione Editar para abrir os detalhes do aplicativo para atualização.
Insira os detalhes do aplicativo para a guia Olá em Adicionar uma guia ao seu aplicativo pessoal.
Insira os seguintes detalhes:
- Nome: guia Olá.
- URL de conteúdo e URL do site: o endereço de encaminhamento na sessão do console do ngrok.
- Contexto: selecione a guia Pessoal.
Selecione Atualizar.
Os detalhes da guia Olá aparecem no painel Aplicativo Pessoal.
Selecione Salvar.
O painel Aplicativo Pessoal agora mostra a nova guia e uma guia Sobre criada automaticamente.
Configurar bot
É fácil adicionar a funcionalidade de bots ao seu aplicativo. O Olá, Mundo de exemplo já tem um bot como parte do exemplo, mas você deve registrá-lo no Teams.
O bot que foi importado do exemplo não tem uma ID de aplicativo associada. Você precisará excluí-lo e criar um bot. O Portal do Desenvolvedor cria uma nova ID de aplicativo e a registra no Teams.
Adicionar e configurar um bot envolve:
Para adicionar um novo bot
Selecione o
ícone no cartão bot no painel recursos do aplicativo e selecione Excluir.Selecione Ferramentas para adicionar funcionalidade.
Selecione Gerenciamento de Bot no painel Ferramentas.
Selecione + Novo Bot no painel de gerenciamento de Bot.
Insira um nome adequado para o bot e selecione Adicionar.
O painel Configurar é exibido mostrando detalhes do novo bot no painel esquerdo.
Insira a URL de encaminhamento no
ngrokconsole e selecione Salvar.
Selecione Segredos do cliente e, em seguida, selecione Adicionar um segredo do cliente ao bot para gerar uma senha para o bot.
O Portal do Desenvolvedor gera uma senha para o bot.
Você pode usar o ícone
para copiar a senha. Para este tutorial, você não precisa copiá-lo.
Selecione OK.
Selecione < Bots para retornar ao painel de gerenciamento de Bot.
O painel de gerenciamento de bot mostra o novo Bot adicionado com uma ID do aplicativo.
Salve a ID do Bot juntamente com a senha da seção Segredo do cliente.
Para adicionar bot ao aplicativo
Abra o painel Recursos do aplicativo e selecione o cartão do Bot .
O painel Bot é exibido.
Selecione seu aplicativo de bot em Selecionar um bot existente e selecione Salvar.
O novo bot é adicionado ao seu aplicativo com sua própria ID de aplicativo.
Para configurar o escopo do bot
Selecione o
ícone no novo cartão do Bot e selecione Editar.Mova-se pelo painel Bot para exibir a seção Comandos e selecione + Adicionar um Comando.
Insira um nome e uma descrição adequados para o Comando.
Selecione todos os três escopos para o comando e selecione Adicionar.
- Pessoal
- Equipe
- Chat em grupo
O novo comando é adicionado à seção Comandos do painel Bot .
Selecione Salvar.
Os detalhes do comando são salvos.
Abra o painel Recursos do aplicativo e selecione Cartão de aplicativo pessoal para exibir os detalhes da guia do aplicativo.
Você verá que uma guia para o novo chatbot é adicionada ao seu aplicativo.
Configurar a extensão de mensagem
As extensões de mensagem permitem que os usuários solicitem informações do seu serviço e postem essas informações. As informações são postadas na forma de cartões na conversa do canal. As extensões de mensagem aparecem na parte inferior da caixa de redação.
Para adicionar uma nova extensão de mensagem:
Selecione o
ícone no cartão extensão de mensagem no painel recursos do aplicativo e selecione Excluir.Selecione Extensão de Mensagem no painel Recursos do aplicativo.
Selecione o nome do aplicativo de bot na lista suspensa Selecionar um bot existente no painel Extensão de mensagem.
Selecione Salvar.
A extensão de mensagem é salva e a seção Comandos aparece no painel Extensão de mensagem.
Selecione + Adicionar um comando para definir o escopo do que seu aplicativo de extensão de mensagem pode fazer.
A caixa de diálogo Adicionar um comando.
Verifique se a Pesquisa está selecionada como o tipo de comando que você deseja adicionar na caixa de diálogo Adicionar um comando .
Insira informações adequadas para os seguintes detalhes:
- ID do comando
- Título do comando
- Descrição do comando
Percorrer a caixa de diálogo para exibir os detalhes restantes.
Verifique se Make default está selecionado.
Selecione os seguintes contextos para o comando de extensão de mensagem:
- Caixa de comando
- Caixa de redação
- Mensagem
Insira informações adequadas para os seguintes detalhes:
- Nome do parâmetro
- Título do parâmetro
- Descrição do parâmetro
Selecione Texto como o tipo de entrada.
Selecione Salvar.
O comando de extensão de mensagem é salvo e aparece na lista de comandos no painel Extensão de mensagem.
Selecione Salvar.
Abra o painel recursos do aplicativo.
Você verá todos os três recursos – aplicativo de guia pessoal, bot e extensão de mensagem – configurados para o Olá, Mundo aplicativo.
Visualizar e testar seu Node.js aplicativo
Depois de importar seu aplicativo e configurar os recursos no Portal do Desenvolvedor, você pode visualizar e testar o aplicativo de exemplo.
Visualizar seu aplicativo no Teams
Depois de configurar os recursos do seu aplicativo, você pode visualizar e testar seu aplicativo no Teams no ambiente local.
Para visualizar seu aplicativo:
Selecione Visualizar no Teams na barra de ferramentas do Portal do Desenvolvedor.
O Portal do Desenvolvedor informa que seu aplicativo foi sideload com êxito.
Selecione Gerenciar seus aplicativos. Seu aplicativo está listado nos aplicativos de sideload.
Localize seu aplicativo usando a caixa de pesquisa, selecione os três pontos em sua linha.
Selecione a opção Exibir . A página Adicionar é exibida para seu aplicativo.
Selecione Adicionar para carregar o aplicativo no Teams.
Seu aplicativo agora está disponível no Teams. Você pode exibir todas as guias e testar os recursos:
Guia Olá:
Chatbot:
Você pode enviar uma mensagem usando o chat.
Extensão de mensagem:
Você pode tentar uma pesquisa usando a extensão de mensagem.
Guia Sobre:
Tem algum problema com essa seção? Se tiver, envie seus comentários para que possamos melhorar esta seção.