Die REST-API Definition ist jetzt im DEV-Branch verfügbar, Vielen Dank an @pauel!
4 „Gefällt mir“
Man kann das auch so konfigurieren, dass das yaml direkt mit swagger korrekt dargestellt wird.
Dabei gibt es u.A. 2 Möglichkeiten:
- Mit einer Github Action generieren lassen und auf einer Github Page anzeigen lassen.
- Swagger direkt in die Webseite auf dem Gerät einbinden, so, dass man dann sein device direkt aus swagger ansteuern kann. Das ist extrem nützlich, um die REST APIs zu testen.
@tueddy @pauel Schaut euch doch bitte mal meinen PR an: Embed swagger UI by caco3 · Pull Request #314 · biologist79/ESPuino · GitHub :
Ich habe die Swagger-Doku noch ins Menu aufgenommen.
Wie macht Ihr das mit dem Review/Mergen? Muss ich da noch explizit jemanden anschreiben oder werdet Ihr von euch aus Aktive?
1 „Gefällt mir“
@CaCO3 Zunächst vielen Dank für Deine Arbeit und den Pull-Request!
Wir bekommen das natürlich mit & schauen uns das an. ESPuino ist ein Hobbyprojekt & je nach freier Zeit geht das mal schneller oder langsamer. Du hast gestern das Forum mit Beiträgen geflutet, für meinen Teil muss ich das erstmal sacken lassen 
Für eine gewisse Transparenz macht es generell Sinn Erweiterungen hier im Forum anzukündigen und kurz zu beschreiben, hast Du ja auch so gemacht. Einfach Code reinschmeissen nach dem Motto „It works for me & jetzt nimm das oder stirb“ kommt halt nicht so gut an…
Zurück zum Thema: Es ist schon fein wenn man die REST-API Dokumentation direkt aufrufen und auch gleich testen kann, ist aber nichts für den normalen Bediener. Bei Deinem Beitrag gestern hatte ich einwenig Bedenken ob so etwas den Speicher belasten kann, hätte Variante 1 bevorzugt. Jede HTML Erweiterung kostet halt auch Platz. Anscheinend hast Du diesen Punkt aber gleich mit bedacht & es sieht wirklich schlank aus.
Nach kurzem Überfliegen hier gibt es von mir 
, sehr elegant gelöst! Ich würde es 1:1 übernehmen wenn niemand schreit…
1 „Gefällt mir“
Danke fürs Feedback!
Bin ja selber auch Hobby-Entwickler und recht aktiv im AI-on-the-edge-device-Projekt, daher weis ich gut, wie es so läuft 
Wir haben es da so gemacht, dass das Web UI auf der SD-Karte liegt, dadurch müssen wir nicht auf den Speicherbedarf schauen. Relevant wird da nur jede API.
Aber der verteilte Ansatz hat leider nicht nur Vorteile, beim schlanken UI vom ESPuino würde ich das auch nicht so machen.
Ich war echt erfreut zu sehen, dass Ihr die API sauber in yaml dokumentiert habt! Dadurch war der Schritt zum Swagger UI nur noch ein kleiner Schritt.