Usar el gem ruby de la API de Discourse

¿Quieres usar la API de Discourse? ¡Genial! Empecemos.

Configurar el entorno de desarrollo de Discourse

Configura el entorno de desarrollo de Discourse usando nuestra guía para Windows, macOS o Ubuntu.

Clonar el Gem de la API de Discourse

Ahora que has configurado el entorno de desarrollo de Discourse, ya deberías tener Git y Ruby instalados en tu sistema. Puedes instalar el gem de la API de Discourse ejecutando el siguiente comando desde la consola:

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

Alternativamente, puedes instalar el gem directamente:

gem install discourse_api

Instalar dependencias

Abre el directorio discourse_api y escribe:

bundle install

Esto instalará todas las dependencias de gem requeridas.

Generar Clave de API

Genera una Clave de API para tu instancia de Discourse visitando /admin/api/keys, para interactuar con la API de Discourse.

Proporcionar Credenciales de API

¡Ahora que has clonado el gem de la API de Discourse y has generado una clave de API, empecemos a usarlo!

Abre el archivo discourse_api/examples/example.rb, y modifica la siguiente información:

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

Reemplaza http://localhost:3000 con la URL de tu instancia de Discourse, ej: http://discourse.example.com

Reemplaza YOUR_API_KEY con la clave de API de tu instancia de Discourse, ej: b1f3175cb682b3e9b6ca419db77772120b19af993cbc14ebed80fea08e3bbd66

Reemplaza YOUR_USERNAME con el nombre de usuario de administrador de tu instancia de Discourse, ej: codinghorror

Acceder a la API de Discourse

Ahora en la consola, desde el directorio discourse_api ejecuta:

ruby examples/example.rb

Este comando imprimirá los temas más recientes de tu instancia de Discourse.

Eso es todo. Empieza a usar la API de Discourse hoy mismo.


Recursos Adicionales:
Documentación de la API de Discourse


Última revisión por @SaraDev el 2022-07-13T01:00:00Z

29 Me gusta