Usar a gem ruby da API Discourse

Então você quer usar a API do Discourse? Ótimo! Vamos começar.

Configurar o ambiente de desenvolvimento do Discourse

Configure o ambiente de desenvolvimento do Discourse usando nosso guia para Windows, macOS ou Ubuntu.

Clonar o Gem do Discourse API

Agora que você configurou o ambiente de desenvolvimento do Discourse, você já deve ter o Git e o Ruby instalados no seu sistema. Você pode instalar o gem do Discourse API executando o seguinte comando no console:

git clone https://github.com/discourse/discourse_api.git ~/discourse_api

Alternativamente, você pode instalar o gem diretamente:

gem install discourse_api

Instalar dependências

Abra o diretório discourse_api e digite:

bundle install

Isso instalará quaisquer dependências de gem necessárias.

Gerar Chave de API

Gere uma Chave de API para sua instância do Discourse visitando /admin/api/keys, para interagir com a API do Discourse.

Fornecer Credenciais de API

Agora que você clonou o gem do Discourse API e gerou uma chave de API, vamos começar a usá-lo!

Abra o arquivo discourse_api/examples/example.rb e modifique as seguintes informações:

client = DiscourseApi::Client.new("http://localhost:3000")
client.api_key = "SUA_CHAVE_DE_API"
client.api_username = "SEU_NOME_DE_USUARIO"

Substitua http://localhost:3000 pelo URL da sua instância do discourse, por exemplo: http://discourse.example.com

Substitua SUA_CHAVE_DE_API pela chave de API da sua instância do discourse, por exemplo: b1f3175cb682b3e9b6ca419db77772120b19af993cbc14ebed80fea08e3bbd66

Substitua SEU_NOME_DE_USUARIO pelo nome de usuário Admin da sua instância do discourse, por exemplo: codinghorror

Acessar a API do Discourse

Agora, no console, a partir do diretório discourse_api, execute:

ruby examples/example.rb

Este comando exibirá os tópicos mais recentes da sua instância do Discourse.

É isso. Comece a usar a API do Discourse hoje mesmo.


Recursos Adicionais:
Documentação da API do Discourse


Última Revisão por @SaraDev em 2022-07-13T01:00:00Z

29 curtidas