使用 Discourse API ruby gem

所以你想使用 Discourse API?太棒了!让我们开始吧。

设置 Discourse 开发环境

请使用我们的 WindowsmacOSUbuntu 指南设置 Discourse 开发环境。

克隆 Discourse API Gem

现在您已经设置了 Discourse 开发环境,您的系统上应该已经安装了 Git 和 Ruby。您可以从控制台运行以下命令来安装 Discourse API gem:

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

或者,您可以直接安装 gem:

gem install discourse_api

安装依赖项

打开 discourse_api 目录并输入:

bundle install

这将安装所有必需的 gem 依赖项。

生成 API 密钥

通过访问 /admin/api/keys 为您的 Discourse 实例生成一个 API 密钥,以便与 Discourse API 进行交互。

提供 API 凭据

既然您已经克隆了 Discourse API gem 并生成了 API 密钥,让我们开始使用它吧!

打开 discourse_api/examples/example.rb 文件,并修改以下信息:

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

http://localhost:3000 替换为您的 discourse 实例的 URL,例如:http://discourse.example.com

YOUR_API_KEY 替换为您 discourse 实例的 API 密钥,例如:b1f3175cb682b3e9b6ca419db77772120b19af993cbc14ebed80fea08e3bbd66

YOUR_USERNAME 替换为您 discourse 实例的管理用户名,例如:codinghorror

访问 Discourse API

现在在控制台中,从 discourse_api 目录运行:

ruby examples/example.rb

此命令将打印出您的 Discourse 实例中最新的主题。

就是这样。今天就开始使用 Discourse API 吧。


附加资源:
Discourse API 文档


@SaraDev2022-07-13T01:00:00Z 最后审阅

29 个赞