API not RESTful - Githubissues

DroneBridge / ESP32

DroneBridge for ESP32. A secure & transparent telemetry link with support for WiFi and ESP-NOW. Supporting MAVLink, MSP, LTM or any other protocol

Apache License 2.0

340 stars 102 forks source link

API not RESTful #74

Closed mmalecki closed 1 month ago

mmalecki commented 2 months ago

While I was working on #73, I noticed that the API (including the one in the v2 dev branch) is not really RESTful. Would you be open to collaborating/merging a PR for making it so?

As an example:

GET /api/settings/request => GET /api/settings
POST /api/settings/change => POST (or PATCH) /api/settings to achieve the typical CRUD-over-REST API style, as well as GET /api/system/reboot to POST /api/system/reboot to satisfy the RESTful requirement of GET requests not having side-effects.

seeul8er commented 2 months ago

That sounds like a good idea, if you want please go ahead and fix it in the v2_dev branch. This will becoming the new release

mmalecki commented 1 month ago

Thanks @seeul8er. Code changes made in #76, just struggling to find out how to get the frontend built, any advice welcome :).

seeul8er commented 1 month ago

Thanks! Unfortunately I have not setup an automated build so far. You have to manually copy & paste the index.html to the frontend folder. Then I usually run the dronebridge.js content through minify-js and paste it instead of the link to the script. I do the same for CSS content using minifier.

seeul8er commented 1 month ago

Fixed with #77