API is not restful (issue a PUT to change a relay status). It can be disabled from web UI (#1192)

code/espurna/api.ino

@@ -19,6 +19,7 @@ typedef struct {
     api_put_callback_f putFn = NULL;
 } web_api_t;
 std::vector<web_api_t> _apis;
+bool _api_restful = API_RESTFUL;
 
 // -----------------------------------------------------------------------------
 
@@ -31,8 +32,14 @@ void _apiWebSocketOnSend(JsonObject& root) {
     root["apiEnabled"] = getSetting("apiEnabled", API_ENABLED).toInt() == 1;
     root["apiKey"] = getSetting("apiKey");
     root["apiRealTime"] = getSetting("apiRealTime", API_REAL_TIME_VALUES).toInt() == 1;
+    root["apiRestFul"] = _api_restful;
 }
 
+void _apiConfigure() {
+    _api_restful = getSetting("apiRestFul", API_RESTFUL).toInt() == 1;
+}
+
+
 // -----------------------------------------------------------------------------
 // API
 // -----------------------------------------------------------------------------
@@ -158,9 +165,11 @@ bool _apiRequestCallback(AsyncWebServerRequest *request) {
 
         // Check if its a PUT
         if (api.putFn != NULL) {
-            if (request->hasParam("value", request->method() == HTTP_PUT)) {
-                AsyncWebParameter* p = request->getParam("value", request->method() == HTTP_PUT);
-                (api.putFn)((p->value()).c_str());
+            if (!_api_restful || (request->method() == HTTP_PUT)) {
+                if (request->hasParam("value", request->method() == HTTP_PUT)) {
+                    AsyncWebParameter* p = request->getParam("value", request->method() == HTTP_PUT);
+                    (api.putFn)((p->value()).c_str());
+                }
             }
         }
 
@@ -215,6 +224,7 @@ void apiSetup() {
     wsOnSendRegister(_apiWebSocketOnSend);
     wsOnReceiveRegister(_apiWebSocketOnReceive);
     webRequestRegister(_apiRequestCallback);
+    espurnaRegisterReload(_apiConfigure);
 }
 
 #endif // API_SUPPORT

code/espurna/config/general.h

@@ -458,6 +458,11 @@
 #define API_ENABLED                 0           // Do not enable API by default
 #endif
 
+#ifndef API_RESTFUL
+#define API_RESTFUL                 1           // A restful API requires changes to be issued as PUT requests
+                                                // Setting this to 0 will allow using GET to change relays, for instance
+#endif
+
 #ifndef API_BUFFER_SIZE
 #define API_BUFFER_SIZE             15          // Size of the buffer for HTTP GET API responses
 #endif

code/html/index.html

@@ -566,6 +566,17 @@
                                     <div class="pure-u-1 pure-u-lg-1-4"><input type="checkbox" name="apiEnabled" /></div>
                                 </div>
 
+                                <div class="pure-g module module-api">
+                                    <label class="pure-u-1 pure-u-lg-1-4">Restful API</label>
+                                    <div class="pure-u-1 pure-u-lg-1-4"><input type="checkbox" name="apiRestFul" /></div>
+                                    <div class="pure-u-0 pure-u-lg-1-2"></div>
+                                    <div class="pure-u-0 pure-u-lg-1-4"></div>
+                                    <div class="pure-u-1 pure-u-lg-3-4 hint">
+                                        If enabled, API requests to change a status (like a relay) must be done using PUT.
+                                        If disabled you can issue them as GET requests (easier from a browser).
+                                    </div>
+                                </div>
+
                                 <div class="pure-g module module-api">
                                     <label class="pure-u-1 pure-u-lg-1-4">Real time API</label>
                                     <div class="pure-u-1 pure-u-lg-1-4"><input type="checkbox" name="apiRealTime" /></div>