mirror of
https://github.com/xoseperez/espurna.git
synced 2026-03-06 16:27:12 +01:00
8e80a7786c
- match paths through a custom AsyncWebHandler instead of using generic not-found fallback handler - allow MQTT-like patterns when registering paths (`simple/path`, `path/+/something`, `path/#`) Replaces `relay/0`, `relay/1` etc. with `relay/+`. Magnitudes are plain paths, but using `/+` in case there's more than 1 magnitude of the same type. - restore `std::function` as callback container (no more single-byte arg nonsense). Still, limit to 1 type per handler type - adds JSON handlers which will receive JsonObject root as both input and output. Same logic as plain - GET returns resource data, PUT updates it. - breaking change to `apiAuthenticate(request)`, it no longer will do `request->send(403)` and expect this to be handled externally. - allow `Api-Key` header containing the key, works for both GET & PUT plain requests. The only way to set apikey for JSON. - add `ApiRequest::param` to retrieve both GET and PUT params (aka args), remove ApiBuffer - remove `API_BUFFER_SIZE`. Allow custom form-data key=value pairs for requests, allow to send basic `String`. - add `API_JSON_BUFFER_SIZE` for the JSON buffer (both input and output) - `/apis` replaced with `/api/list`, no longer uses custom handler and is an `apiRegister` callback - `/api/rpc` custom handler replaced with an `apiRegister` callback WIP further down: - no more `webLog` for API requests, unless `webAccessLog` / `WEB_ACCESS_LOG` is set to `1`. This also needs to happen to the other handlers. - migrate to ArduinoJson v6, since it become apparent it is actually a good upgrade :) - actually make use of JSON endpoints more, right now it's just existing GET for sensors and relays - fork ESPAsyncWebServer to cleanup path parsing and temporary objects attached to the request (also, fix things a lot of things based on PRs there...)
44 lines
939 B
C++
44 lines
939 B
C++
/*
|
|
|
|
API MODULE
|
|
|
|
Copyright (C) 2016-2019 by Xose Pérez <xose dot perez at gmail dot com>
|
|
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "espurna.h"
|
|
#include "web.h"
|
|
|
|
#if WEB_SUPPORT
|
|
|
|
bool apiAuthenticateHeader(AsyncWebServerRequest*, const String& key);
|
|
bool apiAuthenticateParam(AsyncWebServerRequest*, const String& key);
|
|
bool apiAuthenticate(AsyncWebServerRequest*);
|
|
void apiCommonSetup();
|
|
bool apiEnabled();
|
|
bool apiRestFul();
|
|
String apiKey();
|
|
|
|
#endif // WEB_SUPPORT == 1
|
|
|
|
#if WEB_SUPPORT && API_SUPPORT
|
|
|
|
#include "api_impl.h"
|
|
|
|
#include <functional>
|
|
|
|
using ApiBasicHandler = std::function<bool(ApiRequest&)>;
|
|
using ApiJsonHandler = std::function<bool(ApiRequest&, JsonObject& reponse)>;
|
|
|
|
void apiRegister(const String& path, ApiBasicHandler&& get, ApiBasicHandler&& put);
|
|
void apiRegister(const String& path, ApiJsonHandler&& get, ApiJsonHandler&& put);
|
|
|
|
void apiSetup();
|
|
|
|
bool apiError(ApiRequest&);
|
|
bool apiOk(ApiRequest&);
|
|
|
|
#endif // API_SUPPORT == 1
|