feat: Adopt the OpenAPI 3.0 standard for the REST API #50

lib_standalone/AsyncJson.h

@@ -40,6 +40,53 @@ class ChunkPrint : public Print {
     }
 };
 
+class PrettyAsyncJsonResponse {
+  protected:
+    DynamicJsonDocument _jsonBuffer;
+
+    JsonVariant _root;
+    bool        _isValid;
+
+  public:
+    PrettyAsyncJsonResponse(bool isArray = false, size_t maxJsonBufferSize = DYNAMIC_JSON_DOCUMENT_SIZE)
+        : _jsonBuffer(maxJsonBufferSize)
+        , _isValid{false} {
+        if (isArray)
+            _root = _jsonBuffer.createNestedArray();
+        else
+            _root = _jsonBuffer.createNestedObject();
+    }
+
+    ~PrettyAsyncJsonResponse() {
+    }
+
+    JsonVariant & getRoot() {
+        return _root;
+    }
+
+    bool _sourceValid() const {
+        return _isValid;
+    }
+
+    size_t setLength() {
+        return 0;
+    }
+
+    void setContentType(const char * s) {
+    }
+
+    size_t getSize() {
+        return _jsonBuffer.size();
+    }
+
+    size_t _fillBuffer(uint8_t * data, size_t len) {
+        return len;
+    }
+
+    void setCode(uint16_t) {
+    }
+};
+
 class AsyncJsonResponse {
   protected:
     DynamicJsonDocument _jsonBuffer;
@@ -56,14 +103,18 @@ class AsyncJsonResponse {
         else
             _root = _jsonBuffer.createNestedObject();
     }
+
     ~AsyncJsonResponse() {
     }
+
     JsonVariant & getRoot() {
         return _root;
     }
+
     bool _sourceValid() const {
         return _isValid;
     }
+
     size_t setLength() {
         return 0;
     }
@@ -75,6 +126,9 @@ class AsyncJsonResponse {
     size_t _fillBuffer(uint8_t * data, size_t len) {
         return len;
     }
+
+    void setCode(uint16_t) {
+    }
 };
 
 typedef std::function<void(AsyncWebServerRequest * request, JsonVariant & json)> ArJsonRequestHandlerFunction;

lib_standalone/ESP8266React.h

@@ -25,7 +25,7 @@ class DummySettings {
     bool     shower_timer         = true;
     bool     shower_alert         = false;
     bool     hide_led             = false;
-    bool     api_enabled          = true;
+    bool     notoken_api          = false;
 
     // MQTT
     uint16_t publish_time      = 10; // seconds

lib_standalone/ESPAsyncWebServer.h

@@ -11,6 +11,7 @@ class AsyncWebServer;
 class AsyncWebServerRequest;
 class AsyncWebServerResponse;
 class AsyncJsonResponse;
+class PrettyAsyncJsonResponse;
 
 class AsyncWebParameter {
   private:
@@ -68,11 +69,13 @@ class AsyncWebServerRequest {
     AsyncWebServer *          _server;
     WebRequestMethodComposite _method;
 
+    String _url;
+
   public:
     void * _tempObject;
 
-    AsyncWebServerRequest(AsyncWebServer *, AsyncClient *);
-    ~AsyncWebServerRequest();
+    AsyncWebServerRequest(AsyncWebServer *, AsyncClient *){};
+    ~AsyncWebServerRequest(){};
 
     AsyncClient * client() {
         return _client;
@@ -82,13 +85,30 @@ class AsyncWebServerRequest {
         return _method;
     }
 
+    void method(WebRequestMethodComposite method_s) {
+        _method = method_s;
+    }
+
     void addInterestingHeader(const String & name){};
 
+    size_t args() const {
+        return 0;
+    }
+
     void send(AsyncWebServerResponse * response){};
     void send(AsyncJsonResponse * response){};
+    void send(PrettyAsyncJsonResponse * response){};
     void send(int code, const String & contentType = String(), const String & content = String()){};
     void send(int code, const String & contentType, const __FlashStringHelper *){};
 
+    const String & url() const {
+        return _url;
+    }
+
+    void url(const String & url_s) {
+        _url = url_s;
+    }
+
     bool hasParam(const String & name, bool post, bool file) const {
         return false;
     }
@@ -174,9 +194,9 @@ class AsyncWebServerResponse {
     virtual ~AsyncWebServerResponse();
 };
 
-typedef std::function<void(AsyncWebServerRequest * request)> ArRequestHandlerFunction;
+typedef std::function<void(AsyncWebServerRequest * request)>                                                                                ArRequestHandlerFunction;
 typedef std::function<void(AsyncWebServerRequest * request, const String & filename, size_t index, uint8_t * data, size_t len, bool final)> ArUploadHandlerFunction;
-typedef std::function<void(AsyncWebServerRequest * request, uint8_t * data, size_t len, size_t index, size_t total)> ArBodyHandlerFunction;
+typedef std::function<void(AsyncWebServerRequest * request, uint8_t * data, size_t len, size_t index, size_t total)>                        ArBodyHandlerFunction;
 
 class AsyncWebServer {
   protected: