Verwenden Sie das Discourse API Ruby gem

Sie möchten also die Discourse API verwenden? Großartig! Fangen wir an.

Discourse-Entwicklungsumgebung einrichten

Richten Sie die Discourse-Entwicklungsumgebung mithilfe unserer Anleitungen für Windows, macOS oder Ubuntu ein.

Discourse API Gem klonen

Nachdem Sie die Discourse-Entwicklungsumgebung eingerichtet haben, sollten Git und Ruby bereits auf Ihrem System installiert sein. Sie können das Discourse API Gem installieren, indem Sie den folgenden Befehl in der Konsole ausführen:

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

Alternativ können Sie das Gem direkt installieren:

gem install discourse_api

Abhängigkeiten installieren

Öffnen Sie das Verzeichnis discourse_api und geben Sie Folgendes ein:

bundle install

Dadurch werden alle erforderlichen Gem-Abhängigkeiten installiert.

API-Schlüssel generieren

Generieren Sie einen API-Schlüssel für Ihre Discourse-Instanz, indem Sie /admin/api/keys besuchen, um mit der Discourse API zu interagieren.

API-Anmeldeinformationen bereitstellen

Nachdem Sie das Discourse API Gem geklont und einen API-Schlüssel generiert haben, beginnen wir mit der Verwendung!

Öffnen Sie die Datei discourse_api/examples/example.rb und ändern Sie die folgenden Informationen:

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

Ersetzen Sie http://localhost:3000 durch die URL Ihrer Discourse-Instanz, z. B. http://discourse.example.com

Ersetzen Sie YOUR_API_KEY durch den API-Schlüssel Ihrer Discourse-Instanz, z. B. b1f3175cb682b3e9b6ca419db77772120b19af993cbc14ebed80fea08e3bbd66

Ersetzen Sie YOUR_USERNAME durch den Admin-Benutzernamen Ihrer Discourse-Instanz, z. B. codinghorror

Auf die Discourse API zugreifen

Führen Sie nun in der Konsole aus dem Verzeichnis discourse_api Folgendes aus:

ruby examples/example.rb

Dieser Befehl gibt die neuesten Themen aus Ihrer Discourse-Instanz aus.

Das war’s schon. Beginnen Sie noch heute mit der Nutzung der Discourse API.


Zusätzliche Ressourcen:
Discourse API Dokumentation


Zuletzt überprüft von @SaraDev am 2022-07-13T01:00:00Z

29 „Gefällt mir“