Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature HTTP API #1751

Merged
merged 17 commits into from
Jul 23, 2024
Merged

Feature HTTP API #1751

merged 17 commits into from
Jul 23, 2024

Conversation

kevinwieland
Copy link
Contributor

@kevinwieland kevinwieland commented Jul 14, 2024

HTTP API um einfach auf einzelne MQTT Topics zugreifen zu können.

Nutzung per HTTPs GET oder POST möglich.

GET Beispiel (verschlüsselt):
https://IP:8443/v1/?topic=openWB/system/time

POST Beispiel mit curl (verschlüsselt):
curl -k -X POST --data "topic=openWB/system/time" https://ip:8443/v1/
(das -k sorgt dafür das das private SSL Zertifikat akzeptiert wird

ToDo:

  • HTTP-API im UI (de-)aktivierbar machen.
  • Aktivierungsstatus der API bei der Konfiguration des Webservers berücksichtigen (Sites)
  • Ergänzen von Headern in der index.php, damit der Datentyp des zurückgegebenen Inhalts für den Client ersichtlich ist
  • Die zurückgegebenen Daten sollten das folgende Format bekommen: { topic: <TOPIC>, value: <VALUE>, status: "success" }
  • Ergänzen von HTTP Status-Codes im Fehlerfall, Fehlermeldungen auch als JSON formatieren, damit der Datentyp einheitlich bleibt. { topic: <TOPIC>, value: null, status: "error", error: <Fehlermeldung> }
  • Vor dem Merge den letzten Commit "build ui" entfernen!

@benderl benderl force-pushed the feature-http-api branch 3 times, most recently from 5ee6bf6 to b86e3bc Compare July 23, 2024 08:36
@benderl benderl requested a review from LKuemmel July 23, 2024 09:04
@benderl benderl added enhancement New feature or request ui depends on changes in ui repository labels Jul 23, 2024
@benderl
Copy link
Contributor

benderl commented Jul 23, 2024

Im Slack:

Kevin
vor 26 Minuten
scheint zu klappen, kannst du mergen?

@benderl benderl marked this pull request as ready for review July 23, 2024 12:02
@benderl benderl merged commit 77a87ae into master Jul 23, 2024
1 check passed
@benderl benderl deleted the feature-http-api branch July 23, 2024 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request ui depends on changes in ui repository
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants