Discourse wird durch eine vollständige JSON-API unterstützt. Alles, was Sie auf der Website tun können, können Sie auch über die JSON-API tun.
Die API ist unter docs.discourse.org dokumentiert. Sie können auch das Ruby-Gem discourse_api als Client-Bibliothek verwenden. Allerdings ist nicht jeder Endpunkt dokumentiert.
Um herauszufinden, wie man etwas mit der JSON-API macht, können Sie die folgenden Schritte befolgen.
Beispiel: Ein Thema neu kategorisieren.
- Gehen Sie zu einem Thema und beginnen Sie mit der Bearbeitung einer Kategorie:
- Öffnen Sie die Chrome-Entwicklertools, wechseln Sie zur Registerkarte „Netzwerk“ und wählen Sie den Filter „Fetch/XHR“:
- Führen Sie die Operation durch
- Die Anforderungsdaten werden unter der Registerkarte „Payload“ angezeigt
- Sehen Sie sich auch die Vorschau an, um die Ergebnisse zu ermitteln
- Sie haben nun alle benötigten Informationen.
-
Der Endpunkt ist
https://try.discourse.org/t/online-learning/108.json -
Payload wird mit einer
PUT-Anfrage übermittelt -
Der gesendete Parameter ist:
category_id: 5
Mit diesen Informationen können Sie Ihre eigenen Aufrufe mit Ihrer bevorzugten Programmiersprache erstellen. Sie müssen lediglich Ihr Api-Username und Ihren Api-Key zu den Anforderungsheadern hinzufügen. (Weitere Informationen zum Formatieren einer curl-Anfrage an die Discourse-API finden Sie unter https://meta.discourse.org/t/discourse-api-documentation/22706.)
API-Anmeldeinformationen können im Admin-Panel unter /admin/api/keys generiert werden:
